https://github.com/projectsyn/pr-label-tag-action
A GitHub action which looks for specific labels on PRs and creates new SemVer tags after PRs with appropriate labels get merged
https://github.com/projectsyn/pr-label-tag-action
vshn-team-aldebaran
Last synced: 25 days ago
JSON representation
A GitHub action which looks for specific labels on PRs and creates new SemVer tags after PRs with appropriate labels get merged
- Host: GitHub
- URL: https://github.com/projectsyn/pr-label-tag-action
- Owner: projectsyn
- License: mit
- Created: 2023-10-31T13:10:16.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-06-15T08:02:17.000Z (28 days ago)
- Last Synced: 2025-06-15T09:18:50.952Z (28 days ago)
- Topics: vshn-team-aldebaran
- Language: TypeScript
- Homepage:
- Size: 914 KB
- Stars: 0
- Watchers: 8
- Forks: 0
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# GitHub Action to create new SemVer tags based on PR labels
[](https://github.com/super-linter/super-linter)
This action looks for specific labels (by default `bump:major`, `bump:minor`, and
`bump:patch`) on PRs, and creates a new SemVer tag based on the current latest
version of the repository after a PR with one of the labels is merged.
Currently, the action doesn't allow customizing the tag format. It will always
look for SemVer version tags prefixed with `v` and will create such tags.
The action adds a PR comment which shows what will happen if the PR is merged.
The comment is updated when labels are added or removed, if the workflow has
the appropriate triggers (see section "Usage").
The action can optionally trigger follow-up workflows (for example if you want
to automatically create a release after a new tag has been created). This
feature requires that any workflows that should be triggered by the action
have the `workflow_dispatch` trigger option.
## Usage
To use the action with the default configuration you can use the following
workflow config:
```yaml
on:
pull_request:
# Run when PR head branch is updated (synchronize), when the set of PR
# labels is changed (labeled, unlabeled), and after the PR is closed. We
# additionally check for `merged==true` in the event payload on `closed`
# before actually pushing the tag.
types:
- synchronize
- labeled
- unlabeled
- closed
steps:
- name: Create new tag
uses: projectsyn/pr-label-tag-action@v1
```
### Triggering follow-up actions
```yaml
on:
pull_request:
types:
- synchronize
- labeled
- unlabeled
- closed
steps:
- name: Create new tag
uses: projectsyn/pr-label-tag-action@v1
with:
trigger: |
Release
```
See [this repository's "Release" workflow](https://github.com/projectsyn/pr-label-tag-action/blob/main/.github/workflows/release.yml)
for an example workflow that is be triggered correctly on both manually pushed
tags, and tags created by this action.
## Action inputs
| Name | Description | Default |
|------|-------------|---------|
| `github-token` | Token to access GitHub | `github.token` |
| `patch-label` | Label which indicates a patch-level SemVer bump | `bump:patch` |
| `minor-label` | Label which indicates a minor-level SemVer bump | `bump:minor` |
| `major-label` | Label which indicates a major-level SemVer bump | `bump:major` |
| `trigger` | Workflow names of workflows that should be triggered when a new tag is created. Multiple workflows can be specified on separate lines. | "" |
| `release-comment` | Comment that gets posted when a tag will be pushed on merge | "🚀 Merging this PR will release \`\\`" |
| `released-comment` | Comment that gets posted when a tag has been pushed | "🚀 This PR has been released as \[\`\\`\]\(\\)" |
| `unmerged-comment` | Comment that gets posted when a labeled PR gets closed unmerged | "This PR has been closed unmerged. No new release will be created for these changes" |
For inputs `release-comment`, `released-comment` and `unmerged-comment` the action supports the following placeholders:
- `` is replaced with the computed new version
- `` is replaced with the URL to the new tag