Skip to content

Commit 7d232c0

Browse files
committed
fix: Corrects release branch naming
Signed-off-by: Daneyon Hansen <[email protected]>
1 parent 056adfd commit 7d232c0

File tree

1 file changed

+18
-8
lines changed

1 file changed

+18
-8
lines changed

.github/ISSUE_TEMPLATE/new-release.md

+18-8
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ This document defines the process for releasing Gateway API Inference Extension.
3434
export RC=1
3535
```
3636

37-
4. The vLLM image tag defaults to `v0.7.1` for a release. Optionally, change the vLLM image tag. For example:
37+
4. The vLLM image tag defaults to `v0.7.1` for a release. Set the `VLLM` environment variable if a newer [tag][vllm-tag] has been published. For example:
3838

3939
```shell
4040
export VLLM=0.7.2
@@ -45,16 +45,25 @@ This document defines the process for releasing Gateway API Inference Extension.
4545
1. If needed, clone the Gateway API Inference Extension [repo][repo].
4646

4747
```shell
48-
git clone https://github.com/kubernetes-sigs/gateway-api-inference-extension.git -b main
48+
git clone -o ${REMOTE} https://github.com/kubernetes-sigs/gateway-api-inference-extension.git
4949
```
5050

5151
2. If you already have the repo cloned, ensure it’s up-to-date and your local branch is clean.
5252

53-
3. Create a new release branch from the `main` branch. The release branch should be named `release-v${MAJOR}.${MINOR}`, e.g. `release-v0.1`.
53+
3. Release Branch Handling:
54+
- For a Release Candidate:
55+
Create a new release branch from the `main` branch. The branch should be named `release-${MAJOR}.${MINOR}`, for example, `release-0.1`:
5456

55-
```shell
56-
git checkout -b release-v${MAJOR}.${MINOR}
57-
```
57+
```shell
58+
git checkout -b release-${MAJOR}.${MINOR}
59+
```
60+
61+
- For a Major or Minor Release:
62+
A release branch should already exist. In this case, check out the existing branch:
63+
64+
```shell
65+
git checkout -b release-${MAJOR}.${MINOR} ${REMOTE}/release-${MAJOR}.${MINOR}
66+
```
5867

5968
4. Update release-specific content, generate release artifacts, and stage the changes.
6069

@@ -79,7 +88,7 @@ This document defines the process for releasing Gateway API Inference Extension.
7988
6. Push your release branch to the Gateway API Inference Extension remote.
8089

8190
```shell
82-
git push ${REMOTE} release-v${MAJOR}.${MINOR}
91+
git push ${REMOTE} release-${MAJOR}.${MINOR}
8392
```
8493

8594
7. Tag the head of your release branch with the number.
@@ -112,7 +121,7 @@ This document defines the process for releasing Gateway API Inference Extension.
112121
git push ${REMOTE} v${MAJOR}.${MINOR}.0
113122
```
114123

115-
9. Pushing the tag triggers Prow to build and publish the container image to the [staging registry][].
124+
9. Pushing the tag triggers Prow to build and publish the container image to the [staging registry][].
116125
10. Submit a PR against [k8s.io][] to add the staging image tag and SHA to [`k8s-staging-gateway-api-inference-extension/images.yaml`][yaml]. This will
117126
promote the image to the production registry. **Note:** Add a link to this issue when the PR is merged.
118127
11. Test the steps in the tagged quickstart guide after the PR merges, for example: `https://github.com/kubernetes-sigs/gateway-api-inference-extension/blob/v0.1.0-rc.1/pkg/README.md`.
@@ -148,3 +157,4 @@ Use the following steps to announce the release.
148157
[k8s.io]: https://github.com/kubernetes/k8s.io
149158
[yaml]: https://github.com/kubernetes/k8s.io/blob/main/registry.k8s.io/images/k8s-staging-gateway-api-inference-extension/images.yaml
150159
[issue]: https://github.com/kubernetes-sigs/gateway-api-inference-extension/issues/new/choose
160+
[vllm-tag]: https://hub.docker.com/r/vllm/vllm-openai/tags

0 commit comments

Comments
 (0)