action.yml

name: 'GitHub Tag'
description: 'Bump and push git tag on merge'
author: 'Mathieu Dutour'
outputs:
  new_tag:
    description: 'Generated tag'
  new_version:
    description: 'Generated tag without the prefix'
  previous_tag:
    description: 'Previous tag. When no tag exists yet, defaults to a synthetic `{tag_prefix}0.0.0` (e.g. `v0.0.0`).'
  previous_version:
    description: 'Previous tag without the `tag_prefix` (e.g. `0.0.0` when no tag exists yet).'
  release_type:
    description: 'The computed release type (`major`, `minor`, `patch` or `custom` - can be prefixed with `pre`)'
  changelog:
    description: 'The conventional changelog since the previous tag'
inputs:
  github_token:
    description: 'Required for permission to tag the repo.'
    required: true
  default_bump:
    description: 'Which type of bump to use when none explicitly provided when commiting to a release branch (default: `patch`).'
    required: false
    default: 'patch'
  default_prerelease_bump:
    description: 'Which type of bump to use when none explicitly provided when commiting to a prerelease branch (default: `prerelease`).'
    required: false
    default: 'prerelease'
  tag_prefix:
    description: 'A prefix to the tag name (default: `v`).'
    required: false
    default: 'v'
  append_to_pre_release_tag:
    description: 'A suffix to a pre-release tag name (default: `<branch>`).'
    required: false
  custom_tag:
    description: 'Custom tag name. If specified, it overrides bump settings.'
    required: false
  custom_release_rules:
    description: 'Comma separated list of release rules. Format: `<keyword>:<release_type>`. Example: `hotfix:patch,pre-feat:preminor`.'
    required: false
  release_branches:
    description: 'Comma separated list of branches (JavaScript regular expression accepted, matched via `String.prototype.match`) that will generate release tags. On any other branch — and on pull requests — the action logs "Skipping the tag creation" and exits without pushing a tag. Examples: `master` or `.*` or `release.*,hotfix.*,master`...'
    required: false
    default: 'master,main'
  pre_release_branches:
    description: 'Comma separated list of branches (JavaScript regular expression accepted, matched via `String.prototype.match`) that will generate pre-release tags.'
    required: false
  commit_sha:
    description: 'The commit SHA value to add the tag. If specified, it uses this value instead GITHUB_SHA. It could be useful when a previous step merged a branch into github.ref.'
    required: false
  create_annotated_tag:
    description: 'Boolean to create an annotated tag rather than lightweight.'
    required: false
    default: 'false'
  fetch_all_tags:
    description: 'Boolean to fetch all tags for a repo (if false, only the last 100 will be fetched).'
    required: false
    default: 'false'
  dry_run:
    description: 'Do not perform tagging, just calculate next version and changelog, then exit.'
    required: false
    default: 'false'

runs:
  using: 'node24'
  main: 'lib/main.js'
branding:
  icon: 'git-merge'
  color: 'purple'