Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Corrects release branch naming #299

Closed
wants to merge 1 commit into from
Closed

fix: Corrects release branch naming #299

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 18 additions & 8 deletions .github/ISSUE_TEMPLATE/new-release.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ This document defines the process for releasing Gateway API Inference Extension.
export RC=1
```

4. The vLLM image tag defaults to `v0.7.1` for a release. Optionally, change the vLLM image tag. For example:
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:

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

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

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

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`.
3. Release Branch Handling:
- For a Release Candidate:
Create a new release branch from the `main` branch. The branch should be named `release-${MAJOR}.${MINOR}`, for example, `release-0.1`:

```shell
git checkout -b release-v${MAJOR}.${MINOR}
```
```shell
git checkout -b release-${MAJOR}.${MINOR}
```

- For a Major or Minor Release:
A release branch should already exist. In this case, check out the existing branch:

```shell
git checkout -b release-${MAJOR}.${MINOR} ${REMOTE}/release-${MAJOR}.${MINOR}
```

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

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

```shell
git push ${REMOTE} release-v${MAJOR}.${MINOR}
git push ${REMOTE} release-${MAJOR}.${MINOR}
```

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

9. Pushing the tag triggers Prow to build and publish the container image to the [staging registry][].
9. Pushing the tag triggers Prow to build and publish the container image to the [staging registry][].
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
promote the image to the production registry. **Note:** Add a link to this issue when the PR is merged.
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`.
Expand Down Expand Up @@ -148,3 +157,4 @@ Use the following steps to announce the release.
[k8s.io]: https://github.com/kubernetes/k8s.io
[yaml]: https://github.com/kubernetes/k8s.io/blob/main/registry.k8s.io/images/k8s-staging-gateway-api-inference-extension/images.yaml
[issue]: https://github.com/kubernetes-sigs/gateway-api-inference-extension/issues/new/choose
[vllm-tag]: https://hub.docker.com/r/vllm/vllm-openai/tags