Skip to content

Commit c2e89a9

Browse files
committed
Update release process doc for auto-docs push (nginx#2509)
The docs workflow now supports automatically deploying docs. This updates the release process doc explaining how to set that up.
1 parent 1aef631 commit c2e89a9

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

docs/developer/release-process.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ 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./nginxinc/nginx-gateway-fabric/actions/workflows/docs-build-push.yml) for **prod** on the **release branch**.
69+
8. Run the [docs workflow](https://github.com./nginxinc/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.
7070
9. Close the issue created in Step 1.
7171
10. Ensure that the [associated milestone](https://github.com./nginxinc/nginx-gateway-fabric/milestones) is closed.
7272
11. Verify that published artifacts in the release can be installed properly.

0 commit comments

Comments
 (0)