You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: RELEASE.md
+9-8
Original file line number
Diff line number
Diff line change
@@ -37,11 +37,11 @@ release.
37
37
38
38
The following steps must be done by one of the [Gateway API maintainers][gateway-api-team]:
39
39
40
-
For a **PATCH** release:
40
+
#### For a **PATCH** release:
41
41
- Create a new branch in your fork named something like `<githubuser>/release-x.x.x`. Use the new branch
42
42
in the upcoming steps.
43
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.
44
+
- Update `pkg/consts/consts.go` with the new semver tag and any updates to the API review URL.
45
45
- Run the following command `BASE_REF=vmajor.minor.patch make generate` which
46
46
will update generated docs with the correct version info. (Note that you can't
47
47
test with these YAMLs yet as they contain references to elements which wont
@@ -56,10 +56,10 @@ For a **PATCH** release:
56
56
Attach these files to the GitHub release.
57
57
- Update the `README.md` and `site-src/guides/index.md` files to point links and examples to the new release.
58
58
59
-
For a **MAJOR** or **MINOR** release:
59
+
#### For a **MAJOR** or **MINOR** release:
60
60
- Cut a `release-major.minor` branch that we can tag things in as needed.
61
61
- 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.
63
63
- Run the following command `BASE_REF=vmajor.minor.patch make generate` which
64
64
will update generated docs with the correct version info. (Note that you can't
65
65
test with these YAMLs yet as they contain references to elements which wont
@@ -70,10 +70,11 @@ For a **MAJOR** or **MINOR** release:
70
70
- Run the `make build-install-yaml` command which will generate install files in the `release/` directory.
71
71
Attach these files to the GitHub release.
72
72
- 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
77
78
will update generated docs with the correct version info. (Note that you can't
78
79
test with these YAMLs yet as they contain references to elements which wont
79
80
exist until the tag is cut and image is promoted to production registry.)
0 commit comments