Skip to content

Commit 4ec6f85

Browse files
committed
Add clarifying text for release branch names
1 parent e8a9ad0 commit 4ec6f85

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

docs/developer/release-process.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,9 +66,10 @@ To create a new release, follow these steps:
6666
4. `GW_API_PREV_VERSION` in tests Makefile, if necessary.
6767
5. Any references in the docs to the previous release.
6868
6. Any installation instructions to ensure that the supported Gateway API and NGF versions are correct. Specifically, helm README.
69-
8. Prepare and merge a PR into the main branch of [documentation repository](https://github.com/nginx/documentation) from the release branch.
69+
8. Prepare and merge a PR into the main branch of the [documentation repository](https://github.com/nginx/documentation) from the relevant release branch, such as `ngf-release-2.0`.
7070
- Update the HTML file located at `layouts/shortcodes/version-ngf.html` with the latest version. Ensure you do not add an empty line to the file.
7171
- Documentation is built and deployed automatically from `main`, and will trigger when merging to it.
72+
- Create a new branch for the next release version, in the format `ngf-release-<i>.<i>`, substituting the *i* placeholders for major and minor version numbers.
7273
9. Close the issue created in Step 1.
7374
10. Ensure that the [associated milestone](https://github.com/nginx/nginx-gateway-fabric/milestones) is closed.
7475
11. Verify that published artifacts in the release can be installed properly.

0 commit comments

Comments
 (0)