bump-tag-version

• Increment the version using "Composition" without using docker.
• used semver-tool
• It can be run as self-hosted.

Usage

  - name: Bump tag version
    id: tag_version
    uses: keepbang/bump-tag-version@main
    env:
      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
      WITH_V: false
      DEFAULT_BUMP: patch
      PRERELEASE: true
      PRERELEASE_SUFFIX: ${{ env.suffix }}
      DEFAULT_BRANCH: ${{ env.default_branch }}

  - name: tag logging
  run: |
    echo "new_tag = ${{ steps.tag_version.outputs.new_tag }}"
    echo "old_tag = ${{ steps.tag_version.outputs.old_tag }}"
    echo "part = ${{ steps.tag_version.outputs.part }}"
    echo "tag = ${{ steps.tag_version.outputs.tag }}"

Options

Environment Variables

• GITHUB_TOKEN (required) - Required for permission to tag the repo.
• DEFAULT_BUMP (optional) - Which type of bump to use when none explicitly provided (default: minor).
• DEFAULT_BRANCH (optional) - Overwrite the default branch its read from Github Runner env var but can be overwritten (default: $GITHUB_BASE_REF). Strongly recommended to set this var if using anything else than master or main as default branch otherwise in combination with history full will error.
• WITH_V (optional) - Tag version with v character.
• RELEASE_BRANCHES (optional) - Comma separated list of branches (bash reg exp accepted) that will generate the release tags. Other branches and pull-requests generate versions postfixed with the commit hash and do not generate any tag. Examples: master or .* or release.*,hotfix.*,master ...
• CUSTOM_TAG (optional) - Set a custom tag, useful when generating tag based on f.ex FROM image in a docker image. Setting this tag will invalidate any other settings set!
• SOURCE (optional) - Operate on a relative path under $GITHUB_WORKSPACE.
• DRY_RUN (optional) - Determine the next version without tagging the branch. The workflow can use the outputs new_tag and tag in subsequent steps. Possible values are true and false (default).
• GIT_API_TAGGING (optional) - Set if using git cli or git api calls for tag push operations. Possible values are false and true (default).
• INITIAL_VERSION (optional) - Set initial version before bump. Default 0.0.0. MAKE SURE NOT TO USE vX.X.X here if combined WITH_V
• TAG_CONTEXT (optional) - Set the context of the previous tag. Possible values are repo (default) or branch.
• PRERELEASE (optional) - Define if workflow runs in prerelease mode, false by default. Note this will be overwritten if using complex suffix release branches. Use it with checkout ref: ${{ github.sha }} for consistency see issue 266.
• PRERELEASE_SUFFIX (optional) - Suffix for your prerelease versions, beta by default. Note this will only be used if a prerelease branch.
• VERBOSE (optional) - Print git logs. For some projects these logs may be very large. Possible values are true (default) and false.
• MAJOR_STRING_TOKEN (optional) - Change the default #major commit message string tag.
• MINOR_STRING_TOKEN (optional) - Change the default #minor commit message string tag.
• PATCH_STRING_TOKEN (optional) - Change the default #patch commit message string tag.
• NONE_STRING_TOKEN (optional) - Change the default #none commit message string tag.
• BRANCH_HISTORY (optional) - Set the history of the branch for finding #bumps. Possible values last, full and compare defaults to compare.
  • full: attempt to show all history, does not work on rebase and squash due missing HEAD [should be deprecated in v2 is breaking many workflows]
  • last: show the single last commit
  • compare: show all commits since previous repo tag number

Outputs

• new_tag - The value of the newly created tag.
• tag - The value of the latest tag after running this action.
• part - The part of version which was bumped.

License

[MIT][license]

Source

anothrNick/github-tag-action