Skip to content

Fix stable docs not building automatically#321

Merged
jameskermode merged 1 commit intoACEsuit:mainfrom
jameskermode:fix/docs-deployment-320
Jan 6, 2026
Merged

Fix stable docs not building automatically#321
jameskermode merged 1 commit intoACEsuit:mainfrom
jameskermode:fix/docs-deployment-320

Conversation

@jameskermode
Copy link
Collaborator

Summary

  • Uncomment DOCUMENTER_KEY in CI workflow to enable stable documentation deployment on tags

Background

As of v0.10.x, the stable docs weren't building automatically because the DOCUMENTER_KEY environment variable was commented out in .github/workflows/CI.yml. Without this secret, Documenter.jl cannot push to the gh-pages branch when tags are created.

Changes

  • Uncommented line 154 in .github/workflows/CI.yml to pass DOCUMENTER_KEY to the julia-docdeploy action

Test plan

  • Verify CI documentation job runs successfully on this PR
  • After merge, verify stable docs deploy when a new tag is created

Note

If the DOCUMENTER_KEY secret isn't configured in repository settings, it will need to be set up:

  1. Generate SSH key pair
  2. Add public key as deploy key (with write access)
  3. Add private key as DOCUMENTER_KEY secret

Fixes #320

🤖 Generated with Claude Code

Uncomment DOCUMENTER_KEY in CI workflow to enable documentation
deployment on tags. Without this secret, Documenter.jl cannot push
to the gh-pages branch to deploy stable documentation.

Note: This fix requires that the DOCUMENTER_KEY secret is properly
configured in the repository settings. If not already set up, the
maintainer needs to:
1. Generate an SSH key pair
2. Add the public key as a deploy key to the repo (with write access)
3. Add the private key as a secret named DOCUMENTER_KEY

Fixes ACEsuit#320

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <[email protected]>
@jameskermode jameskermode merged commit efc50ce into ACEsuit:main Jan 6, 2026
3 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.

Documentation not building automatically?

1 participant