Skip to content

Commit 37b52e2

Browse files
committed
docs: add patch release section to RELEASE.md
1 parent d2344ea commit 37b52e2

File tree

1 file changed

+21
-4
lines changed

1 file changed

+21
-4
lines changed

RELEASE.md

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,17 +37,34 @@ release.
3737

3838
The following steps must be done by one of the [Gateway API maintainers][gateway-api-team]:
3939

40+
For a patch release:
41+
- Create a new branch in your fork named something like `<githubuser>/release-x.x.x`. Use the new branch
42+
in the upcoming steps.
43+
- Use `git` to cherry-pick all relevant PRs into your branch.
44+
- Update `pkg/generator/main.go` with the new semver tag and any updates to the API review URL.
45+
- Run the following command `BASE_REF=vmajor.minor.patch make generate` which will update generated docs
46+
and webhook with the correct version info. Note that the YAMLs will not work until the tag is actually
47+
published in the next step.
48+
- Create a pull request of the `<githubuser>/release-x.x.x` branch into the `release-x.x` branch upstream
49+
(which should already exist since this is a patch release).
50+
- Verify the CI tests pass and once the above merges publish a new Git tag. This can be done using the
51+
`git` CLI or Github's [release][release] page.
52+
- Run the `make build-install-yaml` command which will generate
53+
install files in the `release/` directory.
54+
- Attach these files to the Github release.
55+
- Update the `README.md` as needed for any latest release references.
56+
4057
For a major or minor release:
4158
- Cut a `release-major.minor` branch that we can tag things in as needed.
4259
- Check out the `release-major.minor` release branch locally.
4360
- Update `pkg/generator/main.go` with the new semver tag and any updates to the API review URL.
4461
- Run the following command `BASE_REF=vmajor.minor.patch make generate` which will update generated docs
4562
and webhook with the correct version info. Note that the YAMLs will not work until the tag is actually
4663
published in the next step.
47-
- Publish a new Git tag. This can be done using the `git` CLI or Github's [release][release]
48-
page.
64+
- Verify the CI tests pass and once the above merges publish a new Git tag. This can be done using the
65+
`git` CLI or Github's [release][release] page.
4966
- Run the `make build-install-yaml` command which will generate
50-
install files in the `release/` directory
67+
install files in the `release/` directory.
5168
- Attach these files to the Github release.
5269
- Update the `README.md` as needed for any latest release references.
5370

@@ -62,7 +79,7 @@ For an RC release:
6279
This can be done using the `git` CLI or Github's [release][release]
6380
page.
6481
- Run the `make build-install-yaml` command which will generate
65-
install files in the `release/` directory
82+
install files in the `release/` directory.
6683
- Attach these files to the Github release.
6784

6885
[release]: https://github.com/kubernetes-sigs/gateway-api/releases

0 commit comments

Comments
 (0)