docs: clarify when to split the PR check into its own workflow#145
Merged
Conversation
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
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.
What
Two doc fixes to the GitHub Actions / snapshots guidance, both prompted by realizing the reasons to prefer a dedicated
bumpy ci checkworkflow weren't written down anywhere — so the docs lead with "inline step" while careful reasoning keeps rediscovering the dedicated-workflow case, making them look like they contradict each other.1.
docs/github-actions.md— "Inline step vs. dedicated workflow" calloutAdds a short note under the PR-check section explaining when to give
ci checkits ownon: pull_requestworkflow instead of folding it into existing CI:workflow_runposter fires on whole-workflow completion, so an emit step buried in a multi-minute CI workflow delays the release-plan comment until lint/typecheck/build/tests all finish. A dedicated check (nobun install) posts in seconds. This is the one reason that specifically argues for a separate file rather than just a separate job.ci checkthat exits non-zero on a missing bump file fails the job and skips the test run, so contributors who push before adding a bump file lose all test signal. A separate workflow (or job) keeps the gates independent.Keeps the inline step as the documented default — this just helps readers self-select.
2.
docs/snapshots.md— fix stalepull_request_targetcross-referenceThe fork note pointed at "the same
pull_request_targetcaveats … as for the check comment," but the check comment no longer usespull_request_target— it uses thepull_request+workflow_runsplit. Updated the wording and pointed the link at the#commenting-on-fork-prsanchor.Why
Docs-only. No behavior change.