Skip to content

Commit 71c234f

Browse files
liu-congCopilot
liu-cong
and
Copilot
authored
release: configure and pass LATENCY_PREDICTOR_TAG via Makefile (llm-d#1675)
* release: configure and pass LATENCY_PREDICTOR_TAG via Makefile Signed-off-by: Cong Liu <conliu@google.com> * Apply suggestions from code review Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Cong Liu <conliu@google.com> --------- Signed-off-by: Cong Liu <conliu@google.com> Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
1 parent f8432d6 commit 71c234f

2 files changed

Lines changed: 69 additions & 40 deletions

File tree

‎.github/ISSUE_TEMPLATE/new-release.md‎

Lines changed: 67 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -25,19 +25,26 @@ This document defines the process for releasing llm-d-router.
2525
`refs/tags/v*` restricts who can push release tags, which is what triggers
2626
the release build.
2727

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:
2929

30-
```shell
31-
export MAJOR=0
32-
export MINOR=1
33-
export PATCH=0
34-
export REMOTE=origin
35-
```
30+
- For a **Release Candidate** (e.g. `v0.9.0-rc.1`):
31+
```shell
32+
export VERSION=v0.9.0-rc.1
33+
export BRANCH_VERSION=0.9
34+
export REMOTE=origin
35+
```
3636

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):
3845

3946
```shell
40-
export RC=1
47+
export LATENCY_PREDICTOR_TAG=v0.8.0-rc.1
4148
```
4249
1. If needed, clone the llm-d-router [repo].
4350

@@ -53,54 +60,46 @@ This document defines the process for releasing llm-d-router.
5360
5461
1. Release Branch Handling:
5562
- 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`:
5764
5865
```shell
59-
git checkout -b release-${MAJOR}.${MINOR}
66+
git checkout -b release-${BRANCH_VERSION}
6067
```
6168
6269
- For a Major, Minor or Patch Release:
6370
A release branch should already exist. In this case, check out the existing branch:
6471
6572
```shell
66-
git checkout release-${MAJOR}.${MINOR} ${REMOTE}/release-${MAJOR}.${MINOR}
73+
git checkout release-${BRANCH_VERSION} ${REMOTE}/release-${BRANCH_VERSION}
6774
```
6875
69-
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):
7078
7179
```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}"
7382
```
7483
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.
8685
8786
```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}
8988
```
9089
91-
1. Push the tag to the llm-d-router repo.
90+
### Tag commit and trigger image build
9291
93-
For a release candidate:
92+
1. Tag the head of your release branch with the version:
9493
95-
```shell
96-
git push ${REMOTE} v${MAJOR}.${MINOR}.${PATCH}-rc.${RC}
97-
```
94+
```shell
95+
git tag -s -a ${VERSION} -m "llm-d-router ${VERSION} Release"
96+
```
9897
99-
For a major, minor or patch release:
98+
1. Push the tag to the llm-d-router repo:
10099
101-
```shell
102-
git push ${REMOTE} v${MAJOR}.${MINOR}.${PATCH}
103-
```
100+
```shell
101+
git push ${REMOTE} ${VERSION}
102+
```
104103
105104
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].
106105
1. Verify the [CI release workflow] completed successfully before proceeding.
@@ -111,21 +110,49 @@ This document defines the process for releasing llm-d-router.
111110
1. Create a [new release]:
112111
1. Choose the tag that you created for the release.
113112
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:
118+
1. Highlights (key features, performance wins, bug fixes)
119+
2. Upgrade Steps & Deprecations (configuration changes, deprecated flags/metrics)
120+
3. Known Issues (if any, otherwise omit)
121+
```
122+
123+
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.
116124
1. If this is a release candidate, select the "This is a pre-release" checkbox.
117125
1. If you find any bugs in this process, create an [issue].
118126
119127
## Announce the Release
120128
121129
Use the following steps to announce the release.
122130
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):
124132
125133
```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}!
140+
141+
### Container Images
142+
* Endpoint Picker: ghcr.io/llm-d/llm-d-router-endpoint-picker:${VERSION}
143+
* Disaggregated Sidecar: ghcr.io/llm-d/llm-d-router-disagg-sidecar:${VERSION}
144+
145+
### Helm Charts (OCI)
146+
* Standalone Chart: oci://ghcr.io/llm-d/charts/llm-d-router-standalone (version ${VERSION})
147+
* Gateway Chart: oci://ghcr.io/llm-d/charts/llm-d-router-gateway (version ${VERSION})
148+
149+
### Release Notes
150+
For more details, please see the GitHub release notes: https://github.com/llm-d/llm-d-router/releases/tag/${VERSION}
151+
EOF
127152
```
128153
154+
1. Copy the generated subject and body, and send an email to `llm-d-contributors@googlegroups.com`.
155+
129156
1. Add a link to the final release in this issue.
130157
131158
1. Close this issue.
@@ -135,3 +162,4 @@ Use the following steps to announce the release.
135162
[new release]: https://github.com/llm-d/llm-d-router/releases/new
136163
[issue]: https://github.com/llm-d/llm-d-router/issues/new/choose
137164
[CI release workflow]: https://github.com/llm-d/llm-d-router/actions/workflows/ci-release.yaml
165+
[latency predictor releases]: https://github.com/orgs/llm-d/packages?repo_name=llm-d-latency-predictor

‎Makefile‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ GIT_COMMIT_SHA ?= $(shell git rev-parse HEAD 2>/dev/null)
5555
# Match only root-level release tags (v[0-9]*) so submodule tags don't leak into image versions.
5656
ROOT_RELEASE_TAG_MATCH ?= v[0-9]*
5757
BUILD_REF ?= $(shell git describe --tags --match '$(ROOT_RELEASE_TAG_MATCH)' --abbrev=0 2>/dev/null)
58+
LATENCY_PREDICTOR_TAG ?= $(or $(EXTRA_TAG),$(BUILD_REF),latest)
5859

5960
# Host directories for Go module and build caches, bind-mounted into the builder container.
6061
GO_MOD_CACHE_VOL ?= $(HOME)/.cache/llm-d-gomodcache
@@ -348,7 +349,7 @@ verify-helm-charts: helm-install kubectl-validate ## Render and validate Helm ch
348349
.PHONY: helm-push
349350
helm-push: yq helm-install ## Package and push a specified Helm chart. Usage: make helm-push CHART=<chart_name>
350351
@if [ -z "$(CHART)" ]; then echo "Error: CHART variable is required (e.g. CHART=llm-d-router-standalone)"; exit 1; fi
351-
CHART=$(CHART) EXTRA_TAG="$(EXTRA_TAG)" CHART_SUFFIX="$(CHART_SUFFIX)" EPP_RELEASE_IMAGE_REPOSITORY="$(EPP_RELEASE_IMAGE_REPOSITORY)" YQ="$(YQ)" HELM="$(HELM)" ./hack/push-chart.sh
352+
CHART=$(CHART) EXTRA_TAG="$(EXTRA_TAG)" CHART_SUFFIX="$(CHART_SUFFIX)" EPP_RELEASE_IMAGE_REPOSITORY="$(EPP_RELEASE_IMAGE_REPOSITORY)" LATENCY_PREDICTOR_TAG="$(LATENCY_PREDICTOR_TAG)" YQ="$(YQ)" HELM="$(HELM)" ./hack/push-chart.sh
352353

353354
.PHONY: helm-push-gateway
354355
helm-push-gateway: ## Package and push the llm-d-router-gateway Helm chart.

0 commit comments

Comments
 (0)