Skip to content

Commit 0cd5ea2

Browse files
author
Kate Osborn
committed
Specify where to find draft changelog in release process doc
Problem: The release process doc does not say where to find the autogenerated draft of the changelog that should be used as a starting point for the manual changelog. Solution: Update the release process doc to describe where to find the changelog draft.
1 parent d20f530 commit 0cd5ea2

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

docs/release-process.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,11 @@ To create a new release, follow these steps:
4747
[conformance tests Makefile](../conformance/Makefile) to `X.Y.Z`.
4848
7. Update the [README](../README.md) to include information about the release.
4949
8. Update the [changelog](../CHANGELOG.md). The changelog includes only important (from the user perspective)
50-
changes to NKG. This is in contrast with the autogenerated full changelog, which is created in the next step. Use
51-
the previous changelog entries for formatting and content guidance.
50+
changes to NKG. This is in contrast with the autogenerated full changelog, which is created in the next step. As
51+
a starting point, copy the important features, bug fixes, and dependencies from the autogenerated draft of the
52+
full changelog. This draft can be found under
53+
the [GitHub releases](https://github.com/nginxinc/nginx-kubernetes-gateway/releases) after the release branch is
54+
created. Use the previous changelog entries for formatting and content guidance.
5255
7. Create and push the release tag in the format `vX.Y.Z`. As a result, the CI/CD pipeline will:
5356
- Build NKG container images with the release tag `X.Y.Z` and push it to the registry.
5457
- Package and publish the Helm chart to the registry.

0 commit comments

Comments
 (0)