SciML / SciML/.github

Restore Documenter gh-pages deployment permissions across 16 repositories

Open
#133 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Julia
Stars
6
Forks
5
Avg merge
2d 1h
Merged PRs (30d)
8

Description

Summary

Sixteen current default-branch documentation checks complete Documenter's check/render pipeline and then fail only while publishing gh-pages. Eleven repositories fail SSH authentication with Permission denied (publickey); five fail HTTPS pushes with HTTP 403.

These are repository credential/permission failures, not documentation build failures. Changing package source or weakening Documenter checks would not fix them.

SSH deploy-key failures

The jobs below reach CheckDocument/RenderDocument, enter deploydocs, and fail while fetching or pushing the SSH remote:

For these repositories, rotate/re-register the DOCUMENTER_KEY pair and ensure the public deploy key has write access. CatalystNetworkAnalysis.jl already has the repository-specific diagnosis at https://github.com/SciML/CatalystNetworkAnalysis.jl/issues/75.

HTTPS token-permission failures

These jobs also build and render successfully, then git push ... HEAD:gh-pages receives HTTP 403:

For these repositories, grant Actions GITHUB_TOKEN write access to repository contents, or configure a valid Documenter deploy key consistently with the rest of the organization.

After correcting the repository settings, rerun the linked workflow runs to verify publication and clear the red default-branch checks.


Investigated by an AI agent using Codex CLI 0.151.0 (model: gpt-5.6-sol; session: local session ID 01a0598f-11b9-72d1-91d9-b2fbb186557d).

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the listed workflow runs and each repository’s Documenter deploydocs configuration. Check the DOCUMENTER_KEY deploy-key access and Actions GITHUB_TOKEN contents permissions for the affected repositories, then rerun the linked workflows. Done means all documentation jobs publish to gh-pages and the default-branch checks pass.

Written by the indexing model from the issue text.

Assessment

Tech stack
github, github-actions, julia
Domain
ci-cd, devops, documentation
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.