Docs pages deploy#1
Open
cybertec-adrian wants to merge 2 commits into
Open
Conversation
Adds a push-on-main-gated deploy job (upload-pages-artifact + deploy-pages) so the site serves at docs.pghardstorage.org. PRs still only build + preview. Needs Pages source = GitHub Actions in settings.
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
1 participant
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.
Summary
The docs workflow built and validated the site (strict mkdocs + linkcheck) but never published it. This adds a deploy job that publishes the rendered
site/to GitHub Pages so the docs serve at the canonical domaindocs.pghardstorage.org(docs/CNAME+site_urlwere already in place). The deploy job is gated to push-on-main, so PRs — including from forks — only build and preview, never publish.Type
Tests
make checkpasses locally (vet + race tests)make test-integration) where touchedCompatibility
Checklist
Author: Hans-Jürgen Schönig <hs@cybertec.at>)