Skip to content

Fix sphinx workflow to clone gh-pages from rai-opensource, not petercorke - #205

Open
petercorke wants to merge 2 commits into
rai-opensource:masterfrom
petercorke:fix/sphinx-gh-pages-remote-url
Open

Fix sphinx workflow to clone gh-pages from rai-opensource, not petercorke#205
petercorke wants to merge 2 commits into
rai-opensource:masterfrom
petercorke:fix/sphinx-gh-pages-remote-url

Conversation

@petercorke

Copy link
Copy Markdown
Collaborator

Summary

  • The Commit documentation changes step in .github/workflows/sphinx.yml still cloned gh-pages from the pre-migration petercorke/spatialmath-python repo, which has no gh-pages branch since the repo moved to rai-opensource.
  • Every docs build has been failing at that step with fatal: Remote branch gh-pages not found in upstream origin (e.g. run 31737932420).
  • Points the clone at rai-opensource/spatialmath-python.git, which has a gh-pages branch already.

Test plan

  • Confirmed gh-pages branch exists on rai-opensource/spatialmath-python
  • Merge and confirm the sphinx workflow succeeds on master

…orke

The Commit documentation changes step still cloned the pre-migration
petercorke/spatialmath-python repo, which has no gh-pages branch,
failing every docs build push with "Remote branch gh-pages not found".
@codecov-commenter

Copy link
Copy Markdown

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@petercorke

Copy link
Copy Markdown
Collaborator Author

The docs at spatialmath-python.rai-inst.com have been stale since January 2025. Merging this one should trigger the first real docs update in a year and a half, and fix the "CI Failing" status

Hardcoding rai-opensource/spatialmath-python fixes today's problem but
carries the same fragility that broke this originally: an owner/repo
baked into the workflow doesn't track future transfers or renames.
${{ github.repository }} always resolves to whatever repo the workflow
is actually running in.
@petercorke

Copy link
Copy Markdown
Collaborator Author

We should also move to publish via GitHub actions not the gh-pages branch. That's a repo setting change + small CI change.

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.

2 participants