You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/ISSUE_TEMPLATE/new-release.md
+67-39Lines changed: 67 additions & 39 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,19 +25,26 @@ This document defines the process for releasing llm-d-router.
25
25
`refs/tags/v*` restricts who can push release tags, which is what triggers
26
26
the release build.
27
27
28
-
1.Set the required environment variables based on the expected release number:
28
+
1.Choose whether you are releasing a release candidate or an official release, and set the environment variables accordingly:
29
29
30
-
```shell
31
-
export MAJOR=0
32
-
exportMINOR=1
33
-
exportPATCH=0
34
-
export REMOTE=origin
35
-
```
30
+
- For a **Release Candidate** (e.g. `v0.9.0-rc.1`):
31
+
```shell
32
+
exportVERSION=v0.9.0-rc.1
33
+
exportBRANCH_VERSION=0.9
34
+
export REMOTE=origin
35
+
```
36
36
37
-
1. If creating a release candidate, set the release candidate number.
37
+
- For an **Official Release** (e.g. `v0.9.0`):
38
+
```shell
39
+
export VERSION=v0.9.0
40
+
export BRANCH_VERSION=0.9
41
+
export REMOTE=origin
42
+
```
43
+
44
+
1. (Optional) If the latency predictor release version does **not** align with the router version, also set the expected tag (refer to the [latency predictor releases] to find the latest valid release tag):
38
45
39
46
```shell
40
-
exportRC=1
47
+
exportLATENCY_PREDICTOR_TAG=v0.8.0-rc.1
41
48
```
42
49
1. If needed, clone the llm-d-router [repo].
43
50
@@ -53,54 +60,46 @@ This document defines the process for releasing llm-d-router.
53
60
54
61
1. Release Branch Handling:
55
62
- For a Release Candidate:
56
-
Create a new release branch from the `main` branch. The branch should be named `release-${MAJOR}.${MINOR}`, for example, `release-0.1`:
63
+
Create a new release branch from the `main` branch. The branch should be named `release-${BRANCH_VERSION}`, for example, `release-0.9`:
57
64
58
65
```shell
59
-
git checkout -b release-${MAJOR}.${MINOR}
66
+
git checkout -b release-${BRANCH_VERSION}
60
67
```
61
68
62
69
- For a Major, Minor or Patch Release:
63
70
A release branch should already exist. In this case, check out the existing branch:
1. Push your release branch to the llm-d-router remote.
76
+
1. By default, `LATENCY_PREDICTOR_TAG` in the `Makefile` resolves from the router release tag (via `BUILD_REF`). If the latency predictor tag does **not** align with the router version, update the default value of `LATENCY_PREDICTOR_TAG` in the `Makefile` to match your exported `${LATENCY_PREDICTOR_TAG}`.
77
+
Commit the change (if modified):
70
78
71
79
```shell
72
-
git push ${REMOTE} release-${MAJOR}.${MINOR}
80
+
# Update LATENCY_PREDICTOR_TAG ?= vX.Y.Z in Makefile
81
+
git commit -a -s -m "release: set LATENCY_PREDICTOR_TAG to ${LATENCY_PREDICTOR_TAG}"
73
82
```
74
83
75
-
### Tag commit and trigger image build
76
-
77
-
1. Tag the head of your release branch with the sem-ver release version.
78
-
79
-
For a release candidate:
80
-
81
-
```shell
82
-
git tag -s -a v${MAJOR}.${MINOR}.${PATCH}-rc.${RC} -m "llm-d-router v${MAJOR}.${MINOR}.${PATCH}-rc.${RC} Release Candidate"
83
-
```
84
-
85
-
For a major, minor or patch release:
84
+
1. Push your release branch to the llm-d-router remote.
86
85
87
86
```shell
88
-
git tag -s -a v${MAJOR}.${MINOR}.${PATCH} -m "llm-d-router v${MAJOR}.${MINOR}.${PATCH} Release"
87
+
git push ${REMOTE} release-${BRANCH_VERSION}
89
88
```
90
89
91
-
1. Push the tag to the llm-d-router repo.
90
+
### Tag commit and trigger image build
92
91
93
-
For a release candidate:
92
+
1. Tag the head of your release branch with the version:
git tag -s -a ${VERSION} -m "llm-d-router ${VERSION} Release"
96
+
```
98
97
99
-
For a major, minor or patch release:
98
+
1. Push the tag to the llm-d-router repo:
100
99
101
-
```shell
102
-
git push ${REMOTE}v${MAJOR}.${MINOR}.${PATCH}
103
-
```
100
+
```shell
101
+
git push ${REMOTE} ${VERSION}
102
+
```
104
103
105
104
1. Pushing the tag triggers CI action to build and publish the EPP image (`ghcr.io/llm-d/llm-d-router-endpoint-picker`) and sidecar image (`ghcr.io/llm-d/llm-d-router-disagg-sidecar`) to the [ghcr registry].
106
105
1. Verify the [CI release workflow] completed successfully before proceeding.
@@ -111,21 +110,49 @@ This document defines the process for releasing llm-d-router.
111
110
1. Create a [new release]:
112
111
1. Choose the tag that you created for the release.
113
112
1. Use the tag as the release title, e.g. `v0.1.0`.
114
-
1. Click "Generate release notes" and preview the release body.
115
-
1. Ensure the release body includes: highlights, breaking changes (if any), known issues, and upgrade steps.
113
+
1. Click "Generate release notes" to auto-populate the list of PRs and contributors.
114
+
1. Summarize the release notes using an LLM of your choice (e.g., Gemini, Copilot, ChatGPT). Provide the newly compiled release notes block from `RELEASE-NOTES.md` (or the unreleased fragments in `release-notes.d/unreleased/`) with the following prompt:
115
+
116
+
```text
117
+
Please summarize these release notes into three clear sections:
Review the generated content, edit it if necessary to ensure accuracy, and then copy and prepend this summary at the very top of the release description box on GitHub.
116
124
1. If this is a release candidate, select the "This is a pre-release" checkbox.
117
125
1. If you find any bugs in this process, create an [issue].
118
126
119
127
## Announce the Release
120
128
121
129
Use the following steps to announce the release.
122
130
123
-
1. Send an announcement email to `llm-d-contributors@googlegroups.com` with the subject:
131
+
1. Generate the announcement email content by running the following block in your terminal (make sure `${VERSION}` is set in your current shell):
124
132
125
133
```shell
126
-
[ANNOUNCE] llm-d-router v${MAJOR}.${MINOR}.${PATCH} is released
134
+
cat <<EOF
135
+
Subject: [ANNOUNCE] llm-d-router ${VERSION} is released
136
+
137
+
Hi all,
138
+
139
+
We are pleased to announce the release of llm-d-router ${VERSION}!
0 commit comments