Repository navigation
Deploy Pages docs within the release workflow - #1012
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
Unresolved workflow issues can break staging custom domains, silently skip production docs updates on API failures, and block subsequent cluster upgrades while awaiting Pages approval.
3 open issues
What changed in this PR
This PR separates production documentation from unreleased changes on main, while adding an optional staging site in a separate GitHub Pages repository.
Changes:
- Deploy production docs from a validated latest stable release tag, including releases published by the upgrade workflow.
- Add optional staging deployment with separate credentials, a configurable base URL, and noindex metadata.
- Document deployment setup and add workflow validation tests.
| File | Description |
|---|---|
hack/release/docs_workflow_test.go |
Tests production triggers, permissions, release integration, and tag validation. |
hack/release/docs_staging_workflow_test.go |
Tests staging isolation, settings, build options, and key requirements. |
docs/layouts/partials/head.html |
Adds conditional noindex metadata. |
docs/hugo.toml |
Defaults noindex to false. |
docs/content/guides/gantry.md |
Uses a Hugo reference for base-path-aware linking. |
.golangci.yaml |
Preserves GitHub Actions’ cancelled() spelling in tests. |
.github/workflows/release-upgrade.yaml |
Calls the docs workflow after publishing a latest release. |
.github/workflows/docs.yaml |
Validates release tags and builds production docs from the selected release. |
.github/workflows/docs-staging.yaml |
Adds optional main-branch publishing to a separate repository. |
.github/docs-deployment.md |
Documents production environment rules and staging setup. |
Review effort: Balanced
A reusable call held the deploy-unbounded-stable concurrency group while the github-pages environment awaited approval, blocking later cluster upgrades. Dispatch main's docs.yaml with only actions: write instead.
Jordan Olshevski (jveski)
marked this pull request as ready for review
October 28, 2026 17:54
Jordan Olshevski (jveski)
changed the title
Jordan Olshevski (jveski)
enabled auto-merge
October 28, 2026 18:11
Jordan Olshevski (jveski)
changed the title
Cameron Childress (cchildress)
approved these changes
Oct 28, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Build and deploy Pages docs inside the release publishing workflow after a latest release is published, using that release tag. Remove the standalone docs workflow and the proposed staging site. Keep the existing Pages site and use only official GitHub actions for docs deployment.