https://github.com/tj-actions/release-tagger
:octocat: Github action to manage action releases.
https://github.com/tj-actions/release-tagger
actions github-actions
Last synced: 4 months ago
JSON representation
:octocat: Github action to manage action releases.
- Host: GitHub
- URL: https://github.com/tj-actions/release-tagger
- Owner: tj-actions
- License: mit
- Created: 2022-09-12T04:55:34.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2025-12-20T17:40:29.000Z (6 months ago)
- Last Synced: 2025-12-22T18:55:38.175Z (6 months ago)
- Topics: actions, github-actions
- Language: Shell
- Homepage:
- Size: 191 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/tj-actions/release-tagger/actions?query=workflow%3ACI)
[](https://github.com/tj-actions/release-tagger/actions?query=workflow%3A%22Update+release+version.%22)
[](https://github.com/search?o=desc\&q=tj-actions+release-tagger+path%3A.github%2Fworkflows+language%3AYAML\&s=\&type=Code)
[](#contributors-)
## release-tagger
Automatically manage [Github action](https://docs.github.com/en/actions/creating-actions) releases by ensuring that a major release is always created or updated to point to the last minor/patch release.
## Usage
> \[!IMPORTANT]
>
> * Any single major version release decription would be overwritten by this action (i.e `v2`). In order to preserve the single major version release description you'll need to create a semantic version. (i.e `v2.0.0`)
```yaml
name: Tag release
on:
push:
tags:
- v*
jobs:
test:
runs-on: ubuntu-latest
name: Create or update major release tag
steps:
- uses: actions/checkout@v4
- name: Run release-tagger
uses: tj-actions/release-tagger@v6.0.0
```
## Inputs
| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION |
|----------------------------------------------------------------------------------------|--------|----------|-------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [gh\_token](#input_gh_token) | string | false | `"${{ github.token }}"` | Github CLI token |
| [release\_notes\_file](#input_release_notes_file) | string | true | `"RELEASE_NOTES.md"` | File to write release notes
to |
| [retag\_major](#input_retag_major) | string | true | `"false"` | Enable retagging major version tags.
e.g v2.0.0 -> v2.0.1 (Retags v2 pointing to v2.0.1) |
| [token](#input_token) | string | false | `"${{ github.token }}"` | [GITHUB\_TOKEN](https://docs.github.com/en/free-pro-team@latest/actions/reference/authentication-in-a-workflow#using-the-github_token-in-a-workflow) or a repo scoped
[Personal Access Token](https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/creating-a-personal-access-token) |
* Free software: [MIT license](LICENSE)
If you feel generous and want to show some extra appreciation:
[![Buy me a coffee][buymeacoffee-shield]][buymeacoffee]
[buymeacoffee]: https://www.buymeacoffee.com/jackton1
[buymeacoffee-shield]: https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png
## Credits
This package was created with [Cookiecutter](https://github.com/cookiecutter/cookiecutter) using [cookiecutter-action](https://github.com/tj-actions/cookiecutter-action)
## Report Bugs
Report bugs at https://github.com/tj-actions/release-tagger/issues.
If you are reporting a bug, please include:
* Your operating system name and version.
* Any details about your workflow that might be helpful in troubleshooting.
* Detailed steps to reproduce the bug.
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
