chore: publish docs from stable release tags only#158
Conversation
|
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 0a16f40bd6
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| - '.github/workflows/docs.yml' | ||
| workflow_dispatch: | ||
| release: | ||
| types: [created] |
There was a problem hiding this comment.
Trigger docs deployment when releases are published
For releases prepared through the GitHub UI as drafts, this created activity will not run; GitHub's release-event docs state that created is skipped for draft releases and that published is the activity that fires when stable or prerelease drafts are published. In that common release flow, publishing the tag/release would leave Pages on the previous docs despite the intent to publish docs from release tags only.
Useful? React with 👍 / 👎.
Summary
release.publishedevents.github.event.release.prerelease.github.event.release.tag_namebefore building.masterpush and manual dispatch triggers so unreleased master docs do not update the live site.Verification
node_modules/.bin/prettier --check .github/workflows/docs.ymlgit diff --checkChangeset