brunopanizzi/auto-pr release PR
Keeps an always-open release pull request from a staging branch to a production branch, with an auto-updated changelog of everything not yet deployed, a customer-facing changelog section, and an automatic version bump.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| github-token | Token used to read merged PRs and create/update the release PR. Needs `pull-requests: write`. | — | ${{ github.token }} |
| base | Production branch the release PR targets. | — | master |
| head | Staging branch the release PR comes from. | — | dev |
| initial-version | Version used for the very first release PR, when no previously merged release PR exists. | — | v0.1.0 |
| bump | Version component bumped when creating a new release PR: major, minor, or patch. | — | minor |
| groups | Optional newline-separated mapping of PR title prefixes to display names, e.g. "OTF: Operação Terra Forte". When set, changelog entries are grouped by the acronym before the dash in each PR title, under the mapped name. All-caps prefixes missing from the mapping get a group under the raw acronym; when empty, the changelog is a flat list. | — | "" |
| ungrouped-label | Group heading used for PRs whose title has no recognizable prefix. Only used when `groups` is set. | — | Other |
| customer-heading | Heading of the customer-facing changelog section, built from the notes authors write between `<!-- changelog:begin -->` and `<!-- changelog:end -->` markers in PR bodies. The section is omitted when no pending PR has notes. | — | Customer changelog |
Outputs
| name | description |
|---|---|
| pr-number | Number of the open release PR (empty if there was nothing to release). |
| pr-url | URL of the open release PR (empty if there was nothing to release). |
| version | Current title of the release PR, human edits included. |
| created | Whether this run created the release PR (true) or updated an existing one (false). |