Skip to content

ci: deploy docs/ to GitHub Pages so README links resolve - #21

Merged
corbym merged 2 commits into
masterfrom
copilot/fix-readme-links-404
Apr 2, 2026
Merged

ci: deploy docs/ to GitHub Pages so README links resolve#21
corbym merged 2 commits into
masterfrom
copilot/fix-readme-links-404

Conversation

Copilot AI commented Apr 2, 2026

Copy link
Copy Markdown
Contributor

The workflow was generating and committing HTML docs to docs/ but never deploying them to GitHub Pages, causing all https://corbym.github.io/gogiven/… links in the README to 404.

Changes

  • generate-docs job: added pages: write / id-token: write permissions and three new steps at the end of the existing job:
    • actions/configure-pages — configures the Pages environment
    • actions/upload-pages-artifact — packages the freshly generated docs/ directory
    • actions/deploy-pages — deploys the artifact to GitHub Pages

Keeping all steps in the same job ensures the deployment uses the just-generated docs without a re-checkout or race condition.

One-time repo setting required: GitHub Pages source must be set to GitHub Actions in repository Settings → Pages.

@corbym
corbym marked this pull request as ready for review April 2, 2026 07:22
@corbym
corbym merged commit 95626ea into master Apr 2, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants