This shows how to use GitHub Actions to build and publish GitHub Pages using Antora.
Includes a pipeline that runs the required Actions to publish a GitHub Pages instance. The pipeline has been inspired by the Pages starter workflows.
Not mentioned in the actions/configure-pages action is the requirement
to correctly configure the repository or else the action will fail:
Settings > Pages > Build and deployment
select Source: GitHub Actions
Additional workflows (beyond the magic pages.yml
) are offered:
pages-gh-cli.yml
(Deploy Pages via GH CLI): usesactions/upload-artifact@v4
and does a three tiered manual build, configure, and deploy of Pages with everything explicitly handled in the workflows. The magicactions/upload-pages-artifact
andactions/deploy-pages
actions are not used.pages-gh-cli-setup.yml
(Setup Pages via GH CLI) andpages-gh-cli-deploy.yml
(Publish Pages via GH CLI): similar to the other mentioned option, however, while also usin the modern (>v4
) version ofactions/upload-artifact
was originally built with the v3 limitations in mind. See the workflow files for additional details.