ci: publish the docs site on release rather than on push to main - #249
Merged
Conversation
Deploying on every merge to main puts the published site ahead of the release the SpriteStudio Docs portal links to, so readers can reach documentation for behavior that has not shipped. Tying the deploy to `release: published` keeps the site and the portal's "coming soon" gate in step. Matches SSPlayerForUnity / SSPlayerForRenPy / SSConverterGUI, which were already release-triggered. `workflow_dispatch` still forces a deploy, and pull requests keep building with --strict (the deploy job is gated on `github.event_name != 'pull_request'`), so broken links and nav gaps are still caught per PR.
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.
Aligns this repository's docs deploy trigger with SSPlayerForUnity / SSPlayerForRenPy / SSConverterGUI, which already publish on
release: published.Why
Deploying on every merge to
mainputs the published site ahead of the release that the SpriteStudio Docs portal links to, so a reader can land on documentation for behavior that has not shipped. Tying the deploy to a published release keeps the site and the portal's "coming soon" gate in step.What changes
workflow_dispatchis unchanged — a manual deploy still works at any time.pull_requestis unchanged, so every PR still builds with--strictand catches broken links / nav gaps. The deploy job is gated ongithub.event_name != 'pull_request', so PRs build without publishing.pathsfilter stays onpull_requestonly; release events do not take one.No behavior change for readers today: GitHub Pages is not yet enabled on this repository.