Skip to content

docs: reshape README Quick start, Usage, and types - #25

Merged
raulgg merged 3 commits into
mainfrom
docs/pull-request-types
Sep 22, 2026
Merged

raulgg merged 3 commits into
mainfrom
docs/pull-request-types

Conversation

@raulgg

@raulgg raulgg commented Sep 21, 2026 •

Copy link
Copy Markdown
Owner

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 and should-run say what this action needs, not how GitHub webhooks work.

Why

stacked and edited sit outside GitHub's default pull_request activities. Copying on: pull_request with no types list never starts a run on gh stack link or when GitHub retargets the next PR after a bottom merge. The old README buried those facts and repeated YAML in two places.

Changes

  • Quick start: types, always-run gate with pull-requests: read, skip from should-run.
  • Usage: pin a major tag (@v1 in examples), merge_group, job-level permissions, pull_request vs pull_request_target, then the full workflow. No RELEASING.md. No patch tag in the pin line.
  • Inputs, Outputs, How should-run is decided, and pull_request types are ### under Usage.
  • Types table: why this action needs opened, synchronize, reopened, edited, stacked.
  • Opening skip rule: remaining bottom, top if you leave it on, mid-stack skips.

Verification

  • npm test
  • Unit test for the change (file)
  • Live path (opened / stacked / synchronize / remaining-bottom)

@raulgg raulgg changed the title docs: explain pull_request types in the README docs: explain pull_request types and add a Quick start Sep 21, 2026
@raulgg
raulgg force-pushed the docs/pull-request-types branch 2 times, most recently from 68b244b to 295a295 Compare September 22, 2026 21:38
Document which on.pull_request.types the usage example lists, keep a
Quick start checklist, and drop the RELEASING.md pointer from Usage.
@raulgg
raulgg force-pushed the docs/pull-request-types branch from 295a295 to 364c1cf Compare September 22, 2026 21:48
@raulgg
raulgg force-pushed the docs/pull-request-types branch from 236f89d to 95f49af Compare September 22, 2026 22:57
@raulgg raulgg changed the title docs: explain pull_request types and add a Quick start docs: reshape README Quick start, Usage, and types Sep 22, 2026
@raulgg
raulgg merged commit 34c6a15 into main Sep 22, 2026
2 checks passed
@raulgg
raulgg deleted the docs/pull-request-types branch September 22, 2026 23:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant