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 #333

Merged
merged 1 commit into from
Feb 15, 2025
Merged

fix: Corrects release branch naming #333

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
24 changes: 17 additions & 7 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 `0.7.2` for a release. Optionally, change the vLLM image tag. For example:
4. The vLLM image tag defaults to `v0.7.2` for a release. Set the `VLLM` environment variable if a newer [tag][vllm-tag] has been published. For example:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: Can we instead point to where the tag is defined? That would let us avoid having multiple sources of truth for this info


```shell
export VLLM=0.7.3
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`:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: Leaving a note mentioning that the patch version is intentionally left out may help.

Some examples of other folks making this mistake also:
https://github.com/kubernetes-sigs/lws/branches/stale


```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 @@ -149,3 +158,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