https://github.com/ruelala/auto-tagger
A GitHub action to auto tag merged PRs following SemVer
https://github.com/ruelala/auto-tagger
action github github-actions python semantic-versioning
Last synced: 6 months ago
JSON representation
A GitHub action to auto tag merged PRs following SemVer
- Host: GitHub
- URL: https://github.com/ruelala/auto-tagger
- Owner: RueLaLa
- License: mit
- Created: 2020-08-10T15:42:11.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-04-29T17:00:02.000Z (9 months ago)
- Last Synced: 2025-06-30T14:50:43.678Z (7 months ago)
- Topics: action, github, github-actions, python, semantic-versioning
- Language: Python
- Homepage:
- Size: 81.1 KB
- Stars: 8
- Watchers: 11
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
auto-tagger
===
# Introduction
This is a simple github action that is triggered on github PR merging that will increment the git tag on the merge commit following [semver](https://semver.org) and add a comment to the merged commit with the new tag.
# Installation
To use this, simply define an action configuration yaml in the `.github/workflows` directory of your repository with the following contents:
```
name: Auto Tagger
on:
pull_request:
types: [closed]
jobs:
auto-tagger:
uses: RueLaLa/auto-tagger/.github/workflows/auto_tagger.yml@master
```
The default Github token created for the action to use has enough permissions to checkout, tag, and push the new tag on the repo that this action is defined in.
# Local Testing
To test the semver component locally, install the python dependencies by running `pip install -r requirements.txt` where auto-tagger is checked out.
Then, cd to the directory you want to test in and run the below command:
```
DRYRUN=True GITHUB_SHA=$(git rev-parse HEAD) /path/to/auto-tagger/entrypoint.py
```
# Usage
Once installed, when merging a pull request, simply include either `#major`, `#minor`, or `#patch` to the commit message. Alternatively, if you don't include of these, a patch level bump will be assumed. Below is an example from the pull request page:
