docs: reshape README Quick start, Usage, and types - #25
Merged
Merged
Conversation
raulgg
force-pushed
the
docs/pull-request-types
branch
2 times, most recently
from
September 22, 2026 21:38
68b244b to
295a295
Compare
Document which on.pull_request.types the usage example lists, keep a Quick start checklist, and drop the RELEASING.md pointer from Usage.
raulgg
force-pushed
the
docs/pull-request-types
branch
from
September 22, 2026 21:48
295a295 to
364c1cf
Compare
raulgg
force-pushed
the
docs/pull-request-types
branch
from
September 22, 2026 22:57
236f89d to
95f49af
Compare
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.
Summary
Rewrite the README how-to: Quick start is three inserts for an existing workflow, Usage is the assembled file plus reference (Inputs, Outputs,
should-run, types). Types andshould-runsay what this action needs, not how GitHub webhooks work.Why
stackedandeditedsit outside GitHub's defaultpull_requestactivities. Copyingon: pull_requestwith notypeslist never starts a run ongh stack linkor when GitHub retargets the next PR after a bottom merge. The old README buried those facts and repeated YAML in two places.Changes
pull-requests: read, skip fromshould-run.@v1in examples),merge_group, job-level permissions,pull_requestvspull_request_target, then the full workflow. NoRELEASING.md. No patch tag in the pin line.should-runis decided, andpull_requesttypes are###under Usage.opened,synchronize,reopened,edited,stacked.Verification
npm test