ci(docs): publish through the shared GitHub Pages workflow - #42
Open
jimisola wants to merge 1 commit into
Open
Conversation
The workflow was a copy of common-publish-to-github-pages.yml -- same checkout, Pages config, Node setup, Antora build, artifact upload and deploy -- so any fix to one had to be remembered in the other. Two differences, both in the shared workflow's favour: - it passes --log-failure-level=fatal to Antora, so a fatal is a failed build rather than a broken site - the `mkdir -p docs/build/site` guard is gone. It made an Antora run that produced nothing deploy an empty directory instead of failing. The repo's own package-lock.json still pins Antora: the shared build action runs `npm ci` when it finds a lockfile and falls back to a pinned install only when there isn't one. Signed-off-by: Jimisola Laursen <jimisola@jimisola.com>
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.
What & Why
publish_gh_pages.ymlwas a line-for-line copy ofcommon-publish-to-github-pages.yml— same checkout, Pages config, Node setup, Antora build, artifact upload, deploy. Any fix to one had to be remembered in the other. It now calls the shared workflow.Two differences, both in the shared one’s favour:
--log-failure-level=fatalto Antora, so a fatal is a failed build rather than a quietly broken site.mkdir -p docs/build/siteguard is gone. It made an Antora run that produced nothing deploy an empty directory instead of failing.The repo’s own
package-lock.jsonstill pins Antora 3.1.15: the shared build action runsnpm ciwhen it finds a lockfile, and falls back to a pinned install only when there is none.Author checklist
actionlintcleanworkflow_dispatch,release: created, push tomain)Test Plan
Merge after reqstool/.github#66 — the shared workflow gains the
build-antora-siteaction there.Then push to
main(or dispatch) and confirm the site builds and deploys as before.