JuliaDiff / JuliaDiff/ReverseDiff.jl
Add `DOCUMENTER_KEY` secret so releases deploy documentation
Nobody has claimed this yet.
- Dominant language
- Julia
- Stars
- 393
- Forks
- 60
- Avg merge
- 18h 24m
- Merged PRs (30d)
- 8
Description
The repository has no Actions secrets (gh api repos/JuliaDiff/ReverseDiff.jl/actions/secrets returns total_count: 0), so secrets.DOCUMENTER_KEY in TagBot.yml expands to an empty string.
TagBot therefore pushes release tags over HTTPS with GITHUB_TOKEN, and GitHub does not start workflow runs for refs pushed with GITHUB_TOKEN. The docs job in ci.yml never runs on a tag, so no versioned documentation has been deployed since v1.15.3 and stable still serves 1.15.3 (#267, #260).
ForwardDiff.jl has the same workflow files but does have the secret, and its tag pushes do trigger CI.
This needs someone with admin rights on the repository:
- Run
DocumenterTools.genkeys(user = "JuliaDiff", repo = "ReverseDiff.jl"). - Add the public key under Settings → Deploy keys, with write access enabled.
- Add the private key as a repository secret named
DOCUMENTER_KEY.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review TagBot.yml and ci.yml to confirm how DOCUMENTER_KEY is consumed and how tag pushes trigger the docs job. Run DocumenterTools.genkeys for JuliaDiff/ReverseDiff.jl, configure the deploy key and repository secret as described, then verify a release tag starts the docs workflow and deploys the versioned documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- ci-cd, documentation, release
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Active
- Clarity
- Clearly specified
- Newbie friendliness
- 35/100