Skip to content

feat(ci): add workflow_dispatch to promote-stable-docs#3080

Merged
caio-pizzol merged 1 commit into
mainfrom
caio/promote-stable-docs-dispatch
May 1, 2026
Merged

feat(ci): add workflow_dispatch to promote-stable-docs#3080
caio-pizzol merged 1 commit into
mainfrom
caio/promote-stable-docs-dispatch

Conversation

@caio-pizzol
Copy link
Copy Markdown
Contributor

The auto path (workflow_run on release-superdoc.yml) only fires when SuperDoc itself releases on stable. Stable bundle runs that ship CLI/SDK/MCP without a SuperDoc release leave docs-stable behind, as does any docs-only refresh between SuperDoc versions. The first stable bundle run after #3070 hit exactly this — docs-stable had to be promoted manually.

Add a manual trigger:

  • `workflow_dispatch` with an optional `sha` input (defaults to the current `origin/stable` head)
  • Job `if:` allows both event types
  • Auto path keeps the v* tag detection so a no-op semantic-release run still cannot advance docs
  • Manual path trusts the operator; no `--force`, so non-fast-forward attempts are rejected by GitHub

Verified:

  • `node --test scripts/tests/release-local.test.mjs` → 23/25 (the 2 fails — SSH preview URL rewrite and `release-esign.yml` shared workspace coverage — are pre-existing on main)
  • New test `docs promotion supports manual workflow_dispatch with optional sha input` asserts the trigger, input, job condition, and that the manual push step doesn't accidentally depend on the auto path's `detect.outputs`
  • YAML parses

Review: ignore the two pre-existing test failures listed above.

The auto path (workflow_run on release-superdoc.yml) only fires when
SuperDoc itself releases on stable. Stable bundle runs that ship
CLI/SDK/MCP without a SuperDoc release leave docs-stable behind, as
does any docs-only refresh between SuperDoc versions.

Add a manual trigger that pushes the current origin/stable head (or a
specified SHA via the `sha` input). The auto path keeps the v* tag
detection so a no-op semantic-release run still cannot advance docs;
the manual path trusts the operator. No --force, so non-fast-forward
attempts are rejected by GitHub.
@caio-pizzol caio-pizzol requested a review from a team as a code owner May 1, 2026 23:53
@caio-pizzol caio-pizzol merged commit 3cb41b0 into main May 1, 2026
9 of 10 checks passed
@caio-pizzol caio-pizzol deleted the caio/promote-stable-docs-dispatch branch May 1, 2026 23:54
@codecov-commenter
Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants