From 35a5176b3364b4140fb39122ad99bd0d16486a7e Mon Sep 17 00:00:00 2001 From: Alan Dooley Date: Fri, 21 Feb 2025 15:02:05 +0000 Subject: [PATCH 1/2] Update documentation step for the release process User-facing documentation was migrated to the main NGINX documentation repository. This commit changes the instructions and tooling configuration to reflect what has changed. --- .github/workflows/release-pr.yml | 8 -------- docs/developer/release-process.md | 4 +++- 2 files changed, 3 insertions(+), 9 deletions(-) diff --git a/.github/workflows/release-pr.yml b/.github/workflows/release-pr.yml index 6faa64abf0..231e5c7f1e 100644 --- a/.github/workflows/release-pr.yml +++ b/.github/workflows/release-pr.yml @@ -46,14 +46,6 @@ jobs: # TODO(lucacome): improve this and maybe use appVersion instead of version if we switch to tags echo "current_version=$(yq '.version' > $GITHUB_OUTPUT - - name: Find and Replace - uses: jacobtomlinson/gha-find-replace@f1069b438f125e5395d84d1c6fd3b559a7880cb5 # 3.0.5 - with: - find: ${{ steps.vars.outputs.current_version }} - replace: ${{ inputs.version }} - include: "site/content/**/*.md" - regex: false - - name: Find and Replace uses: jacobtomlinson/gha-find-replace@f1069b438f125e5395d84d1c6fd3b559a7880cb5 # 3.0.5 with: diff --git a/docs/developer/release-process.md b/docs/developer/release-process.md index d215c10556..331805e325 100644 --- a/docs/developer/release-process.md +++ b/docs/developer/release-process.md @@ -66,7 +66,9 @@ To create a new release, follow these steps: 4. `GW_API_PREV_VERSION` in tests Makefile, if necessary. 5. Any references in the docs to the previous release. 6. Any installation instructions to ensure that the supported Gateway API and NGF versions are correct. Specifically, helm README. -8. Run the [docs workflow](https://github.com/nginx/nginx-gateway-fabric/actions/workflows/docs-build-push.yml) for **prod** on the **release branch**. Open a PR to the release branch to turn auto-deploy on for the docs workflow in this branch. See [this README](https://github.com/nginxinc/docs-actions/tree/v1.0.4?tab=readme-ov-file#caller-example) for how to do this. Docs should only be auto-published when changes to the `site/` directory are made. +8. Prepare and merge a PR into the main branch of [documentation repository](https://github.com/nginx/documentation) from the release branch. + - 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. + - Documentation is built and deployed automatically from `main`, and will trigger when merging to it. 9. Close the issue created in Step 1. 10. Ensure that the [associated milestone](https://github.com/nginx/nginx-gateway-fabric/milestones) is closed. 11. Verify that published artifacts in the release can be installed properly. From 4ec6f85e356acf684b36e77b0c9870ffe8b325ab Mon Sep 17 00:00:00 2001 From: Alan Dooley Date: Fri, 21 Feb 2025 16:23:57 +0000 Subject: [PATCH 2/2] Add clarifying text for release branch names --- docs/developer/release-process.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/developer/release-process.md b/docs/developer/release-process.md index 331805e325..993c994509 100644 --- a/docs/developer/release-process.md +++ b/docs/developer/release-process.md @@ -66,9 +66,10 @@ To create a new release, follow these steps: 4. `GW_API_PREV_VERSION` in tests Makefile, if necessary. 5. Any references in the docs to the previous release. 6. Any installation instructions to ensure that the supported Gateway API and NGF versions are correct. Specifically, helm README. -8. Prepare and merge a PR into the main branch of [documentation repository](https://github.com/nginx/documentation) from the release branch. +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`. - 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. - Documentation is built and deployed automatically from `main`, and will trigger when merging to it. + - Create a new branch for the next release version, in the format `ngf-release-.`, substituting the *i* placeholders for major and minor version numbers. 9. Close the issue created in Step 1. 10. Ensure that the [associated milestone](https://github.com/nginx/nginx-gateway-fabric/milestones) is closed. 11. Verify that published artifacts in the release can be installed properly.