Skip to content

Commit 9f7dd62

Browse files
authored
Update release docs with new details (#3364)
Signed-off-by: Nick Young <[email protected]>
1 parent 9b0bda4 commit 9f7dd62

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

RELEASE.md

+9-8
Original file line numberDiff line numberDiff line change
@@ -37,11 +37,11 @@ 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:
40+
#### For a **PATCH** release:
4141
- Create a new branch in your fork named something like `<githubuser>/release-x.x.x`. Use the new branch
4242
in the upcoming steps.
4343
- 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.
44+
- Update `pkg/consts/consts.go` with the new semver tag and any updates to the API review URL.
4545
- Run the following command `BASE_REF=vmajor.minor.patch make generate` which
4646
will update generated docs with the correct version info. (Note that you can't
4747
test with these YAMLs yet as they contain references to elements which wont
@@ -56,10 +56,10 @@ For a **PATCH** release:
5656
Attach these files to the GitHub release.
5757
- Update the `README.md` and `site-src/guides/index.md` files to point links and examples to the new release.
5858

59-
For a **MAJOR** or **MINOR** release:
59+
#### For a **MAJOR** or **MINOR** release:
6060
- Cut a `release-major.minor` branch that we can tag things in as needed.
6161
- Check out the `release-major.minor` release branch locally.
62-
- Update `pkg/generator/main.go` with the new semver tag and any updates to the API review URL.
62+
- Update `pkg/consts/consts.go` with the new semver tag and any updates to the API review URL.
6363
- Run the following command `BASE_REF=vmajor.minor.patch make generate` which
6464
will update generated docs with the correct version info. (Note that you can't
6565
test with these YAMLs yet as they contain references to elements which wont
@@ -70,10 +70,11 @@ For a **MAJOR** or **MINOR** release:
7070
- Run the `make build-install-yaml` command which will generate install files in the `release/` directory.
7171
Attach these files to the GitHub release.
7272
- Update the `README.md` and `site-src/guides/index.md` files to point links and examples to the new release.
73-
- Update the implementation table path (`nav.Implementations.Comparison`) in the nav of `mkdocs.yml` to point to the latest release file (for example Implementation Comparison points to `implmenetation-table-v1.1.0.md`). Add the now past version under `Past Version Comparisons`, and edit the text blurb in `mkdocs-generate-conformance.py` to also reflect the added past version.
74-
For an **RC** release:
75-
- Update `pkg/generator/main.go` with the new semver tag and any updates to the API review URL.
76-
- Run the following command `BASE_REF=vmajor.minor.patch make generate` which
73+
- Update the implementation table path (`nav.Implementations.Comparison`) in the nav of `mkdocs.yml` to point to the latest release file (for example Implementation Comparison points to `implmenetation-table-v1.1.0.md`). Add the now past version under `Past Version Comparisons`, and edit the text blurb in `mkdocs-generate-conformance.py` to also reflect the added past version.
74+
75+
#### For an **RC** release:
76+
- Update `pkg/consts/consts.go` with the new semver tag (like `v1.2.0-rc1`) and any updates to the API review URL.
77+
- Run the following command `make generate` which
7778
will update generated docs with the correct version info. (Note that you can't
7879
test with these YAMLs yet as they contain references to elements which wont
7980
exist until the tag is cut and image is promoted to production registry.)

0 commit comments

Comments
 (0)