Skip to content

ci: extract reusable docs workflow, add manual docs-publish trigger - #658

Merged
petercorke merged 3 commits into
mainfrom
ci/manual-docs-publish
Aug 29, 2026
Merged

ci: extract reusable docs workflow, add manual docs-publish trigger#658
petercorke merged 3 commits into
mainfrom
ci/manual-docs-publish

Conversation

@petercorke

Copy link
Copy Markdown
Owner

Summary

  • Extracts the Sphinx + JupyterLite build/deploy steps out of ci.yml into a workflow_call reusable workflow (docs.yml), so the logic lives in one place.
  • Adds docs-publish.yml, a workflow_dispatch-only entry point that calls the same docs.yml steps without waiting on the full OS/Python test matrix — useful for a docs-only fix that doesn't need the whole suite to re-run first.
  • ci.yml behavior is unchanged: its docs job still runs only after test-core/test pass, just delegates to docs.yml instead of duplicating the steps.
  • Deployment to GitHub Pages still only happens when run against main (checked inside docs.yml's docs-deploy job), so a manual dispatch from another branch just builds, it doesn't publish.

Test plan

  • Confirm ci.yml still builds + deploys docs on a push to main, same as before
  • Manually dispatch "Docs Publish (manual)" from the Actions tab against main and confirm it builds and deploys the site
  • Manually dispatch it from a non-main branch and confirm it builds but does not attempt to deploy

Splits the Sphinx + JupyterLite build/deploy steps out of ci.yml into a
workflow_call reusable workflow (docs.yml), then adds docs-publish.yml
as a workflow_dispatch entry point that calls the same steps without
waiting on the full OS/Python test matrix -- e.g. for a docs-only fix.
ci.yml's docs job is unchanged in behavior, just delegates to docs.yml.
@codecov

codecov Bot commented Aug 29, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 0.00%. Comparing base (4ba11d1) to head (b1ac118).

Additional details and impacted files
@@          Coverage Diff          @@
##            main    #658   +/-   ##
=====================================
  Coverage   0.00%   0.00%           
=====================================
  Files        143     143           
  Lines      14050   14050           
=====================================
  Misses     14050   14050           

☔ 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.

Consistent name across RTB/MVTB/bdsim for the manual docs-publish button.
@petercorke
petercorke merged commit 0c5be6d into main Aug 29, 2026
23 checks passed
@petercorke
petercorke deleted the ci/manual-docs-publish branch August 29, 2026 05:56
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