Skip to content

Use GitHub token for documentation deploy - #57

Merged
quinnj merged 1 commit into
masterfrom
fix/documenter-token-deploy
Aug 10, 2026
Merged

Use GitHub token for documentation deploy#57
quinnj merged 1 commit into
masterfrom
fix/documenter-token-deploy

Conversation

@quinnj

@quinnj quinnj commented Aug 10, 2026

Copy link
Copy Markdown
Member

Summary

  • Stop passing the stale DOCUMENTER_KEY to Documenter.
  • Use the existing GITHUB_TOKEN with the job's contents: write permission.
  • Restore documentation deployment from master.

Root cause

Documenter prefers DOCUMENTER_KEY when it is present. The configured SSH key no longer authenticates, so deployment failed before the valid GitHub token could be used.

Validation

  • Workflow YAML parses.
  • Documenter selects HTTPS authentication when only GITHUB_TOKEN is present.
  • The full local documentation build passes.

Co-authored by Codex

@codecov

codecov Bot commented Aug 10, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 82.25%. Comparing base (b2d89de) to head (fd45bf8).

Additional details and impacted files
@@           Coverage Diff           @@
##           master      #57   +/-   ##
=======================================
  Coverage   82.25%   82.25%           
=======================================
  Files           1        1           
  Lines         124      124           
=======================================
  Hits          102      102           
  Misses         22       22           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@quinnj
quinnj merged commit 450599b into master Aug 10, 2026
9 checks passed
@quinnj
quinnj deleted the fix/documenter-token-deploy branch August 10, 2026 01:26
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.

1 participant