Skip to content

Commit 54c1026

Browse files
authored
updating release issue-template (#361)
Signed-off-by: Kellen Swain <kfswain@google.com>
1 parent e24e0d8 commit 54c1026

File tree

1 file changed

+26
-36
lines changed

1 file changed

+26
-36
lines changed

.github/ISSUE_TEMPLATE/new-release.md

Lines changed: 26 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ This document defines the process for releasing llm-d-inference-scheduler.
2121

2222
1. Permissions to push to the llm-d-inference-scheduler repository.
2323

24-
2. Set the required environment variables based on the expected release number:
24+
1. Set the required environment variables based on the expected release number:
2525

2626
```shell
2727
export MAJOR=0
@@ -30,23 +30,24 @@ This document defines the process for releasing llm-d-inference-scheduler.
3030
export REMOTE=origin
3131
```
3232

33-
3. If creating a release candidate, set the release candidate number.
33+
1. If creating a release candidate, set the release candidate number.
3434

3535
```shell
3636
export RC=1
3737
```
38-
39-
## Release Process
40-
4138
1. If needed, clone the llm-d-inference-scheduler [repo].
4239

4340
```shell
4441
git clone -o ${REMOTE} git@github.com:llm-d/llm-d-inference-scheduler.git
4542
```
4643

47-
2. If you already have the repo cloned, ensure it’s up-to-date and your local branch is clean.
44+
## Release Process
45+
46+
### Create or Checkout branch
47+
48+
1. If you already have the repo cloned, ensure it’s up-to-date and your local branch is clean.
4849

49-
3. Release Branch Handling:
50+
1. Release Branch Handling:
5051
- For a Release Candidate:
5152
Create a new release branch from the `main` branch. The branch should be named `release-${MAJOR}.${MINOR}`, for example, `release-0.1`:
5253

@@ -61,29 +62,15 @@ This document defines the process for releasing llm-d-inference-scheduler.
6162
git checkout -b release-${MAJOR}.${MINOR} ${REMOTE}/release-${MAJOR}.${MINOR}
6263
```
6364

64-
4. Update release-specific content, generate release artifacts, and stage the changes.
65-
66-
5. Sign, commit, and push the changes to the `llm-d-inference-scheduler` repo.
67-
68-
For a release candidate:
69-
70-
```shell
71-
git commit -s -m "Updates artifacts for v${MAJOR}.${MINOR}.${PATCH}-rc.${RC} release"
72-
```
73-
74-
For a major, minor or patch release:
75-
76-
```shell
77-
git commit -s -m "Updates artifacts for v${MAJOR}.${MINOR}.${PATCH} release"
78-
```
79-
80-
6. Push your release branch to the llm-d-inference-scheduler remote.
65+
1. Push your release branch to the llm-d-inference-scheduler remote.
8166

8267
```shell
8368
git push ${REMOTE} release-${MAJOR}.${MINOR}
8469
```
8570

86-
7. Tag the head of your release branch with the number.
71+
### Tag commit and trigger image build
72+
73+
1. Tag the head of your release branch with the sem-ver release version.
8774

8875
For a release candidate:
8976

@@ -97,7 +84,7 @@ This document defines the process for releasing llm-d-inference-scheduler.
9784
git tag -s -a v${MAJOR}.${MINOR}.${PATCH} -m 'llm-d-inference-scheduler v${MAJOR}.${MINOR}.${PATCH} Release'
9885
```
9986

100-
8. Push the tag to the llm-d-inference-scheduler repo.
87+
1. Push the tag to the llm-d-inference-scheduler repo.
10188

10289
For a release candidate:
10390

@@ -111,15 +98,18 @@ This document defines the process for releasing llm-d-inference-scheduler.
11198
git push ${REMOTE} v${MAJOR}.${MINOR}.${PATCH}
11299
```
113100

114-
9. Pushing the tag triggers CI action to build and publish the container image to the [ghcr registry].
115-
10. Test the steps in the tagged quickstart guide after the PR merges. TODO add e2e tests! <!-- link to an e2e tests once we have such one -->
116-
11. Create a [new release]:
101+
1. Pushing the tag triggers CI action to build and publish the container image to the [ghcr registry].
102+
1. Test the steps in the tagged quickstart guide after the PR merges. TODO add e2e tests! <!-- link to an e2e tests once we have such one -->
103+
104+
### Create the release!
105+
106+
1. Create a [new release]:
117107
1. Choose the tag that you created for the release.
118-
2. Use the tag as the release title, i.e. `v0.1.0` refer to previous release for the content of the release body.
119-
3. Click "Generate release notes" and preview the release body.
120-
4. Go to Gateway Inference Extension latest release and make sure to include the highlights in llm-d-inference-scheduler as well.
121-
5. If this is a release candidate, select the "This is a pre-release" checkbox.
122-
12. If you find any bugs in this process, create an [issue].
108+
1. Use the tag as the release title, i.e. `v0.1.0` refer to previous release for the content of the release body.
109+
1. Click "Generate release notes" and preview the release body.
110+
1. Go to Gateway Inference Extension latest release and make sure to include the highlights in llm-d-inference-scheduler as well.
111+
1. If this is a release candidate, select the "This is a pre-release" checkbox.
112+
1. If you find any bugs in this process, create an [issue].
123113

124114
## Announce the Release
125115

@@ -131,9 +121,9 @@ Use the following steps to announce the release.
131121
[ANNOUNCE] llm-d-inference-scheduler v${MAJOR}.${MINOR}.${PATCH} is released
132122
```
133123

134-
2. Add a link to the final release in this issue.
124+
1. Add a link to the final release in this issue.
135125

136-
3. Close this issue.
126+
1. Close this issue.
137127

138128
[repo]: https://github.com/llm-d/llm-d-inference-scheduler
139129
[ghcr registry]: https://github.com/llm-d/llm-d-inference-scheduler/pkgs/container/llm-d-inference-scheduler

0 commit comments

Comments
 (0)