Skip to content

ci: let workflow_dispatch actually deploy docs, rename to "Docs Publish" - #102

Open
petercorke wants to merge 1 commit into
mainfrom
ci/docs-manual-dispatch-deploy
Open

ci: let workflow_dispatch actually deploy docs, rename to "Docs Publish"#102
petercorke wants to merge 1 commit into
mainfrom
ci/docs-manual-dispatch-deploy

Conversation

@petercorke

Copy link
Copy Markdown
Owner

Summary

  • docs.yml already listed workflow_dispatch as a trigger, but the upload-pages-artifact step and the deploy job were both gated on github.event_name == 'push' — a manual run silently built the docs and threw the result away without publishing. Widens both guards to also allow workflow_dispatch.
  • Adds an explicit github.ref == 'refs/heads/main' check on deploy, since workflow_dispatch (unlike push, already restricted via branches: [main]) can be run against any branch — a manual dispatch from a feature branch now builds but doesn't publish.
  • Renames the workflow from "Docs" to "Docs Publish" to match the same button name across RTB/bdsim.

Test plan

  • Push to main still builds + deploys docs, same as before
  • A PR still triggers a build-only run (no artifact upload, no deploy)
  • Manually dispatch "Docs Publish" against main and confirm it now actually deploys
  • Manually dispatch it from a non-main branch and confirm it builds but does not deploy

docs.yml already had a workflow_dispatch trigger, but the Pages-artifact
upload and the deploy job were both gated on github.event_name == 'push',
so a manual run silently built the docs and threw the result away without
publishing anything. Widens both to also allow workflow_dispatch, and adds
an explicit ref check on deploy (dispatch can target any branch, push is
already restricted to main via the branches: filter).

Also renames the workflow to "Docs Publish" to match the same button
across RTB/MVTB/bdsim.
@codacy-production

Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.

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