Custom prefix, optional versioning based on multiple commit messages

.act/.env

@@ -0,0 +1 @@
+GITHUB_STEP_SUMMARY=/dev/stdout

.github/workflows/tests/_assert.sh

@@ -0,0 +1,13 @@
+#!/usr/bin/env bash
+
+OUTPUT_NEWTAG=$1
+CORRECT_TAG=$2
+
+if [[ "${OUTPUT_NEWTAG}" == "${CORRECT_TAG}" ]]; then
+    echo "The tag was created correctly" >>"$GITHUB_STEP_SUMMARY"
+    rm -rf test-repo
+else
+    echo "The tag was not created correctly, expected $CORRECT_TAG got $OUTPUT_NEWTAG" >>"$GITHUB_STEP_SUMMARY"
+    rm -rf test-repo
+    exit 1
+fi

.github/workflows/tests/branch_latest_commit_new_tag_on_master_fast_forward.sh

@@ -0,0 +1,29 @@
+#!/usr/bin/env bash
+
+mkdir test-repo
+cd test-repo || exit 1
+
+git config --global init.defaultBranch master
+git config --global user.email "[email protected]"
+git config --global user.name "Your Name"
+
+git init
+touch 1.txt && git add . && git commit -m "1_master.txt"
+touch 2.txt && git add . && git commit -m "2_master.txt"
+git tag 1.1.1
+
+git checkout -b my-feature-branch
+touch 3_feautre.txt && git add . && git commit -m "#minor 3_feature.txt" 
+touch 4_feautre.txt && git add . && git commit -m "4_feature.txt" 
+touch 5_feautre.txt && git add . && git commit -m "#minor 5_feature.txt" 
+echo "LATEST_FEATURE_BRANCH_COMMIT_SHA=$(git rev-parse HEAD)" >> "$GITHUB_OUTPUT"
+
+git checkout master
+touch 6.txt && git add . && git commit -m "#minor 6_master.txt" 
+touch 7.txt && git add . && git commit -m "#minor 7_master.txt"
+git tag 2.3.4 
+
+git checkout my-feature-branch
+git rebase master
+
+git merge my-feature-branch --no-edit --ff-only

.github/workflows/tests/branch_latest_commit_new_tag_on_master_merge_commit.sh

@@ -0,0 +1,25 @@
+#!/usr/bin/env bash
+
+mkdir test-repo
+cd test-repo || exit 1
+
+git config --global init.defaultBranch master
+git config --global user.email "[email protected]"
+git config --global user.name "Your Name"
+
+git init
+touch 1.txt && git add . && git commit -m "1_master.txt"
+touch 2.txt && git add . && git commit -m "2_master.txt"
+git tag 1.1.1
+
+git checkout -b my-feature-branch
+touch 3_feautre.txt && git add . && git commit -m "#minor 3_feature.txt" 
+touch 4_feautre.txt && git add . && git commit -m "4_feature.txt" 
+touch 5_feautre.txt && git add . && git commit -m "#minor 5_feature.txt" 
+echo "LATEST_FEATURE_BRANCH_COMMIT_SHA=$(git rev-parse HEAD)" >> "$GITHUB_OUTPUT"
+
+git checkout master
+touch 6.txt && git add . && git commit -m "#minor 6_master.txt" 
+touch 7.txt && git add . && git commit -m "#minor 7_master.txt"
+git tag 2.3.4 
+git merge my-feature-branch --no-edit

.github/workflows/tests/branch_latest_commit_no_new_tags_on_master_fast_forward.sh

@@ -0,0 +1,28 @@
+#!/usr/bin/env bash
+
+mkdir test-repo
+cd test-repo || exit 1
+
+git config --global init.defaultBranch master
+git config --global user.email "[email protected]"
+git config --global user.name "Your Name"
+
+git init
+touch 1.txt && git add . && git commit -m "1_master.txt"
+touch 2.txt && git add . && git commit -m "2_master.txt"
+git tag 1.1.1
+
+git checkout -b my-feature-branch
+touch 3_feautre.txt && git add . && git commit -m "#minor 3_feature.txt" 
+touch 4_feautre.txt && git add . && git commit -m "4_feature.txt" 
+touch 5_feautre.txt && git add . && git commit -m "#minor 5_feature.txt" 
+echo "LATEST_FEATURE_BRANCH_COMMIT_SHA=$(git rev-parse HEAD)" >> "$GITHUB_OUTPUT"
+
+git checkout master
+touch 6.txt && git add . && git commit -m "#minor 6_master.txt" 
+touch 7.txt && git add . && git commit -m "#minor 7_master.txt" 
+
+git checkout my-feature-branch
+git rebase master
+
+git merge my-feature-branch --no-edit --ff-only

.github/workflows/tests/branch_latest_commit_no_new_tags_on_master_merge_commit.sh

@@ -0,0 +1,24 @@
+#!/usr/bin/env bash
+
+mkdir test-repo
+cd test-repo || exit 1
+
+git config --global init.defaultBranch master
+git config --global user.email "[email protected]"
+git config --global user.name "Your Name"
+
+git init
+touch 1.txt && git add . && git commit -m "1_master.txt"
+touch 2.txt && git add . && git commit -m "2_master.txt"
+git tag 1.1.1
+
+git checkout -b my-feature-branch
+touch 3_feautre.txt && git add . && git commit -m "#minor 3_feature.txt" 
+touch 4_feautre.txt && git add . && git commit -m "4_feature.txt" 
+touch 5_feautre.txt && git add . && git commit -m "#minor 5_feature.txt" 
+echo "LATEST_FEATURE_BRANCH_COMMIT_SHA=$(git rev-parse HEAD)" >> "$GITHUB_OUTPUT"
+
+git checkout master
+touch 6.txt && git add . && git commit -m "#minor 6_master.txt" 
+touch 7.txt && git add . && git commit -m "#minor 7_master.txt" 
+git merge my-feature-branch --no-edit

.github/workflows/tests/custom_string_token.sh

@@ -0,0 +1,21 @@
+#!/usr/bin/env bash
+
+mkdir test-repo
+cd test-repo || exit 1
+
+git config --global init.defaultBranch master
+git config --global user.email "[email protected]"
+git config --global user.name "Your Name"
+
+git init
+touch 1.txt && git add . && git commit -m "1.txt"
+git tag 1.1.1
+touch 2.txt && git add . && git commit -m "2.txt"
+touch 3.txt && git add . && git commit -m "ma 3.txt"
+touch 4.txt && git add . && git commit -m "4.txt"
+touch 5.txt && git add . && git commit -m "ma 5.txt"
+touch 6.txt && git add . && git commit -m "6.txt"
+touch 7.txt && git add . && git commit -m "mi 7.txt"
+touch 8.txt && git add . && git commit -m "pa 8.txt"
+touch 9.txt && git add . && git commit -m "mi 9.txt"
+touch 10.txt && git add . && git commit -m "mi 10.txt"

.github/workflows/tests/default-bump.sh

@@ -0,0 +1,14 @@
+#!/usr/bin/env bash
+
+mkdir test-repo
+cd test-repo || exit 1
+
+git config --global init.defaultBranch master
+git config --global user.email "[email protected]"
+git config --global user.name "Your Name"
+
+git init
+touch 1.txt && git add . && git commit -m "1.txt"
+touch 2.txt && git add . && git commit -m "2.txt"
+git tag 1.1.1
+touch 3.txt && git add . && git commit -m "3.txt"

.github/workflows/tests/initial_tag_creation.sh

@@ -0,0 +1,12 @@
+#!/usr/bin/env bash
+
+mkdir test-repo
+cd test-repo || exit 1
+
+git config --global init.defaultBranch master
+git config --global user.email "[email protected]"
+git config --global user.name "Your Name"
+
+git init
+touch 1.txt && git add . && git commit -m "#major 1.txt"
+touch 2.txt && git add . && git commit -m "#major 2.txt"

.github/workflows/tests/several_commits_default_bump.sh

@@ -0,0 +1,17 @@
+#!/usr/bin/env bash
+
+mkdir test-repo
+cd test-repo || exit 1
+
+git config --global init.defaultBranch master
+git config --global user.email "[email protected]"
+git config --global user.name "Your Name"
+
+git init
+touch 1.txt && git add . && git commit -m "1.txt"
+git tag 1.1.1
+touch 2.txt && git add . && git commit -m "2.txt"
+touch 3.txt && git add . && git commit -m "3.txt"
+touch 4.txt && git add . && git commit -m "4.txt"
+touch 5.txt && git add . && git commit -m "5.txt"
+touch 6.txt && git add . && git commit -m "6.txt"

.github/workflows/tests/several_commits_major_takes_precedence_over_patch.sh

@@ -0,0 +1,20 @@
+#!/usr/bin/env bash
+
+mkdir test-repo
+cd test-repo || exit 1
+
+git config --global init.defaultBranch master
+git config --global user.email "[email protected]"
+git config --global user.name "Your Name"
+
+git init
+touch 1.txt && git add . && git commit -m "1.txt"
+git tag 1.1.1
+touch 2.txt && git add . && git commit -m "2.txt"
+touch 3.txt && git add . && git commit -m "#patch 3.txt"
+touch 4.txt && git add . && git commit -m "4.txt"
+touch 5.txt && git add . && git commit -m "5.txt #patch"
+touch 7.txt && git add . && git commit -m "6.txt #patch"
+touch 8.txt && git add . && git commit -m "6.txt #minor"
+touch 9.txt && git add . && git commit -m "6.txt #minor"
+touch 10.txt && git add . && git commit -m "#minor_6.txt"

.github/workflows/tests/several_mixed_tagged_and_not_tagged_commits.sh

@@ -0,0 +1,17 @@
+#!/usr/bin/env bash
+
+mkdir test-repo
+cd test-repo || exit 1
+
+git config --global init.defaultBranch master
+git config --global user.email "[email protected]"
+git config --global user.name "Your Name"
+
+git init
+touch 1.txt && git add . && git commit -m "1.txt"
+git tag 1.1.1
+touch 2.txt && git add . && git commit -m "2.txt"
+touch 3.txt && git add . && git commit -m "#minor 3.txt"
+touch 4.txt && git add . && git commit -m "4.txt"
+touch 5.txt && git add . && git commit -m "5.txt #minor"
+touch 6.txt && git add . && git commit -m "6.txt"

.github/workflows/tests/tag_with_prefix_is_bumped_if_tag_with_given_prefix_already_exists.sh

@@ -0,0 +1,14 @@
+#!/usr/bin/env bash
+
+mkdir test-repo
+cd test-repo || exit 1
+
+git config --global init.defaultBranch master
+git config --global user.email "[email protected]"
+git config --global user.name "Your Name"
+
+git init
+touch 1.txt && git add . && git commit -m "1.txt"
+touch 2.txt && git add . && git commit -m "2.txt"
+git tag prefix-1.1.1
+touch 3.txt && git add . && git commit -m "#patch 3.txt"

.vscode/tasks.json

@@ -0,0 +1,20 @@
+{
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "label": "act - test run-tests",
+      "command": "act",
+      "options": {
+        "cwd": "${workspaceFolder}"
+      },
+      "args": [
+        "--rebuild",
+        "--job",
+        "run-tests",
+        "--env-file",
+        ".act/.env",
+      ],
+      "type": "shell",
+    }
+  ]
+}

Dockerfile

@@ -1,9 +1,13 @@
-FROM node:16-alpine
+FROM node:16-bullseye-slim
 LABEL "repository"="https://github.com/anothrNick/github-tag-action"
 LABEL "homepage"="https://github.com/anothrNick/github-tag-action"
 LABEL "maintainer"="Nick Sjostrom"
 
-RUN apk --no-cache add bash git curl jq && npm install -g semver
+RUN apt-get update -y \
+    && apt-get install bash=5.1-2+deb11u1 git=1:2.30.2-1 curl=7.74.0-1.3+deb11u3 jq=1.6-2.1 --no-install-recommends -y \ 
+    && apt-get clean \
+    && rm -rf /var/lib/apt/lists/* \
+    && npm install -g semver
 
 COPY entrypoint.sh /entrypoint.sh
 

README.md

@@ -35,7 +35,7 @@ jobs:
       uses: anothrNick/[email protected] # Don't use @master unless you're happy to test the latest version
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        WITH_V: true
+        PREFIX: myprefix-
 ```
 
 ```yaml
@@ -60,7 +60,7 @@ jobs:
       uses: anothrNick/[email protected] # Don't use @master unless you're happy to test the latest version
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        WITH_V: true
+        PREFIX: myprefix-
 ```
 
 Depending if you choose example 1 or example 2 is how crafted version bumps operate when reading the commit log.
@@ -73,19 +73,22 @@ _NOTE: set the fetch-depth for `actions/checkout@v2` or newer to be sure you ret
 
 **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`).
+- **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).
-- **INITIAL_VERSION** _(optional)_ - Set initial version before bump. Default `0.0.0`.
-- **TAG_CONTEXT** _(optional)_ - Set the context of the previous tag. Possible values are `repo` (default) or `branch`.
+- **WITH_V** **(deprecated)** *(optional)* - Tag version with `v` character. Deprecated variable - use `PREFIX` instead.
+- **PREFIX** *(optional)* - Adds a prefix before version number.
+- **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).
+- **INITIAL_VERSION** *(optional)* - Set initial version before bump. Default `0.0.0`. It must be in a valid semver version format (optionally it can also be prefixed with PREFIX param, but it's not necessary even if PREFIX is specified). If the format is incorrect error is thrown.
+- **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.
-- **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`.
+- **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```. 
+- **BRANCH_LATEST_COMMIT** *(optional)* - Commit messages for commits of a given branch will be taken into account while calculating a new tag. Specifying branch is useful when using this action for pull requests - one can set environment variable as follows: `BRANCH_LATEST_COMMIT: ${{ github.event.pull_request.head.sha }}` to calculate a new version basing on commits from a given PR.  If not specified the current commit is used.
+- **USE_LAST_COMMIT_ONLY** *(optional)* - True by default. If true only last commit is taken into account while bumping the version, otherwise all commits from the branch with the latest tag contribute to new tag calculation
 - **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.
@@ -97,9 +100,10 @@ _NOTE: set the fetch-depth for `actions/checkout@v2` or newer to be sure you ret
 
 ### 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.
+- **new_tag** - The value of the newly created tag, e.g. my-prefix-1.2.3
+- **new_tag_without_prefix** - The value of the newly created tag without specified prefix, e.g 1.2.3
+- **tag** - The value of the latest tag before bumping it by running this action, e.g. my-prefix-1.2.2
+- **part** - The part of version which was bumped, e.g. minor
 
 > **_Note:_** This action creates a [lightweight tag](https://developer.github.com/v3/git/refs/#create-a-reference).
 

action.yml

@@ -7,8 +7,10 @@ runs:
 outputs:
   new_tag:
     description: 'Generated tag'
+  new_tag_without_prefix:
+    description: 'Generated tag without specified prefix'
   tag:
-    description: 'The latest tag after running this action'
+    description: 'The latest tag before running this action'
   part:
     description: 'The part of version which was bumped'
 branding: