Repository navigation
Fix documentation CI - #121
Merged
Merged
Conversation
* Update GitHub Actions to current versions * Mark PDF files as binary to keep byte offsets intact on Windows * Skip existing symbolic links when extracting attachments on Windows
* Deploy docs with GITHUB_TOKEN instead of stale DOCUMENTER_KEY The docs job reported success, but deploydocs failed to fetch over SSH because the DOCUMENTER_KEY secret is no longer valid, so gh-pages has not been updated since 2021. Drop DOCUMENTER_KEY so Documenter uses GITHUB_TOKEN, and grant the docs job contents: write. Also point the README Project.toml link at GitHub, since the relative link does not resolve inside the docs build. * Update README Julia requirement to 1.10 to match Project.toml * Add mailto: to README email link so Documenter resolves it
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Hello @sambitdash thanks for merging my earlier PRs. I noticed the CI was failing again, so in order to try and help you you can hopefully publish a new release on JuliaHub, I am also proposing this fix, which replaces a DOCUMENTER_KEY with a GITHUB_TOKEN, which I expect may be a nice simplification too. Thansk for your work.
Brief
The docs job on master shows as passing, but deploydocs fails:
Proposed Changes:
Remove DOCUMENTER_KEY from the docs step so Documenter deploys with GITHUB_TOKEN.
Give the docs job permissions: contents: write so the token can push to gh-pages even if the repo default is read-only.
Use an absolute URL for the README Project.toml link, which Documenter flagged as unresolved.
The test job failures seen earlier on master (actions/cache@v1 deprecation) were already fixed by #120.
Deploy only runs on pushes to master, so this PR's CI can only confirm the build; the deploy fix takes effect after merge upstream.