From 0cd5ea22b2ba7d1d24c834c9da7cfe2c9b8d63d2 Mon Sep 17 00:00:00 2001 From: Kate Osborn Date: Tue, 25 Jul 2023 11:55:45 -0600 Subject: [PATCH] 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. --- docs/release-process.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/release-process.md b/docs/release-process.md index e5cf15754d..4c7e50a684 100644 --- a/docs/release-process.md +++ b/docs/release-process.md @@ -47,8 +47,11 @@ To create a new release, follow these steps: [conformance tests Makefile](../conformance/Makefile) to `X.Y.Z`. 7. Update the [README](../README.md) to include information about the release. 8. Update the [changelog](../CHANGELOG.md). The changelog includes only important (from the user perspective) - changes to NKG. This is in contrast with the autogenerated full changelog, which is created in the next step. Use - the previous changelog entries for formatting and content guidance. + changes to NKG. This is in contrast with the autogenerated full changelog, which is created in the next step. As + a starting point, copy the important features, bug fixes, and dependencies from the autogenerated draft of the + full changelog. This draft can be found under + the [GitHub releases](https://github.com/nginxinc/nginx-kubernetes-gateway/releases) after the release branch is + created. Use the previous changelog entries for formatting and content guidance. 7. Create and push the release tag in the format `vX.Y.Z`. As a result, the CI/CD pipeline will: - Build NKG container images with the release tag `X.Y.Z` and push it to the registry. - Package and publish the Helm chart to the registry.