ci: drop the docs PR build, leaving release + dispatch only - #250
Merged
Conversation
Every sibling repository now publishes its docs site on exactly two triggers:
`release: published` and `workflow_dispatch`. SSPlayerForUnity and
SSPlayerForRenPy already had that shape; this brings the rest in line so the
deploy semantics are identical across the ecosystem.
Removing the pull_request trigger also removes what it was guarding, so the
now-dead conditionals go with it: the `if: github.event_name != 'pull_request'`
on the artifact upload and on the deploy job, and the ref-scoped concurrency
group (`docs-pages-${{ github.ref }}` with PR-only cancellation) which reverts
to `group: pages` / `cancel-in-progress: false`.
Trade-off worth stating: pages.yml is the only workflow that builds the docs
here, so `mkdocs build --strict` no longer runs before merge — a broken
internal link or a missing nav entry now surfaces on the release deploy rather
than on the PR that introduced it. Run `mkdocs build --strict` locally before
merging a docs change.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Follow-up to #249. Completes the trigger unification: every repository's docs site now publishes on exactly
release: published+workflow_dispatch, and nothing else.SSPlayerForUnity and SSPlayerForRenPy already had this shape; SSPlayerForFlutter, SSConverterGUI and SSPlayerForWeb get the same change in parallel PRs.
What changes
pull_requesttrigger removed fromon:.if: github.event_name != 'pull_request'on the Upload Pages artifact stepif: github.event_name != 'pull_request'on thedeployjobconcurrency: docs-pages-${{ github.ref }}/cancel-in-progress: ${{ github.event_name == 'pull_request' }}→group: pages/cancel-in-progress: false, matching the siblingsNet: 9 insertions, 15 deletions. No job-level
if:remains.Trade-off
pages.ymlis the only workflow in this repository that builds the docs, somkdocs build --strictno longer runs before merge. A broken internal link or a missing nav entry now surfaces on the release deploy rather than on the PR that introduced it. Runmkdocs build --strictlocally before merging a docs change — the workflow comment now says so.GitHub Pages is not yet enabled here, so nothing changes for readers today.