Skip to content

Commit 2d5f21d

Browse files
authored
Update documentation step for the release process (#3158)
User-facing documentation was migrated to the main NGINX documentation repository. This commit changes the instructions and tooling configuration to reflect what has changed.
1 parent a382a1c commit 2d5f21d

File tree

2 files changed

+4
-9
lines changed

2 files changed

+4
-9
lines changed

.github/workflows/release-pr.yml

-8
Original file line numberDiff line numberDiff line change
@@ -46,14 +46,6 @@ jobs:
4646
# TODO(lucacome): improve this and maybe use appVersion instead of version if we switch to tags
4747
echo "current_version=$(yq '.version' <charts/nginx-gateway-fabric/Chart.yaml)" >> $GITHUB_OUTPUT
4848
49-
- name: Find and Replace
50-
uses: jacobtomlinson/gha-find-replace@f1069b438f125e5395d84d1c6fd3b559a7880cb5 # 3.0.5
51-
with:
52-
find: ${{ steps.vars.outputs.current_version }}
53-
replace: ${{ inputs.version }}
54-
include: "site/content/**/*.md"
55-
regex: false
56-
5749
- name: Find and Replace
5850
uses: jacobtomlinson/gha-find-replace@f1069b438f125e5395d84d1c6fd3b559a7880cb5 # 3.0.5
5951
with:

docs/developer/release-process.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -66,7 +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. 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.
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`.
70+
- 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.
71+
- 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.
7073
9. Close the issue created in Step 1.
7174
10. Ensure that the [associated milestone](https://github.com/nginx/nginx-gateway-fabric/milestones) is closed.
7275
11. Verify that published artifacts in the release can be installed properly.

0 commit comments

Comments
 (0)