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.e v2.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@970a1f5f827a7b90902b0adc904f3bb70c1074e7 # v6.0.6

Inputs

- uses: tj-actions/release-tagger@970a1f5f827a7b90902b0adc904f3bb70c1074e7 # v6.0.6
  id: release-tagger
  with:
    # Github CLI token
    # Type: string
    # Default: "${{ github.token }}"
    gh_token: ''

    # File to write release notes 
    # to 
    # Type: string
    # Default: "RELEASE_NOTES.md"
    release_notes_file: ''

    # Enable retagging major version tags. 
    # e.g v2.0.0 -> v2.0.1 (Retags v2 pointing to v2.0.1) 
    # Type: boolean
    # Default: "false"
    retag_major: ''

    # [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) 
    # Type: string
    # Default: "${{ github.token }}"
    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):

Raphael Boidol 📖

This project follows the all-contributors specification. Contributions of any kind welcome!