Awesome
release-tagger
Automatically manage Github action 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.ev2.0.0)
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@v4
Inputs
<!-- AUTO-DOC-INPUT:START - Do not remove or modify this section -->| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION |
|---|---|---|---|---|
| <a name="input_gh_token"></a>gh_token | string | false | "${{ github.token }}" | Github CLI token |
| <a name="input_release_notes_file"></a>release_notes_file | string | true | "RELEASE_NOTES.md" | File to write release notes <br>to |
| <a name="input_token"></a>token | string | false | "${{ github.token }}" | GITHUB_TOKEN or a repo scoped <br>Personal Access Token |
- Free software: MIT license
If you feel generous and want to show some extra appreciation:
Credits
This package was created with Cookiecutter using 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):
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> <!-- prettier-ignore-start --> <!-- markdownlint-disable --> <table> <tbody> <tr> <td align="center" valign="top" width="14.28%"><a href="https://boidol.dev/"><img src="https://avatars.githubusercontent.com/u/652404?v=4?s=100" width="100px;" alt="Raphael Boidol"/><br /><sub><b>Raphael Boidol</b></sub></a><br /><a href="https://github.com/tj-actions/release-tagger/commits?author=boidolr" title="Documentation">📖</a></td> </tr> </tbody> </table> <!-- markdownlint-restore --> <!-- prettier-ignore-end --> <!-- ALL-CONTRIBUTORS-LIST:END -->This project follows the all-contributors specification. Contributions of any kind welcome!