Auto version bump

.github/workflows/release.yml

@@ -9,9 +9,12 @@ on:
         default: 'patch'
         type: choice
         options:
+          - auto
           - patch
           - minor
           - major
+      baseTag:
+        description: 'base release tag'
   pull_request:
     types: [closed]
 
@@ -29,3 +32,4 @@ jobs:
           semver: ${{ github.event.inputs.semver }}
           sync-semver-tags: 'true'
           build-command: npm ci
+          base-tag: ${{ github.event.inputs.baseTag }}

README.md

@@ -37,6 +37,7 @@ on:
         default: "patch"
         type: choice
         options:
+          - auto
           - patch
           - minor
           - major
@@ -88,6 +89,10 @@ When you merge this PR:
 
 When you close the PR without merging it: nothing will happen.
 
+## Using 'auto' bump version option
+If you choose the "auto" option for semver version updates, the action will attempt to determine the new version number based on the commit messages. For this option to work, the repository must use the conventional commits standard. You can refer the [conventional commits documention](https://www.conventionalcommits.org/en/v1.0.0/)
+for more information.
+
 ## Using branches filter
 
 In case you want to reduce the amount of the relase workflow runs, you can configure a workflow to run only for pull requests that target specific branches.
@@ -193,7 +198,7 @@ Please note that in case of a prerelease the `sync-semver-tags` input will be tr
 | Input          | Required | Description                                                                                                                                                                                |
 | ---            | ---      | ---                                                                                                                                                                                        |
 | `github-token` | No      | This is your GitHub token, it's [already available](https://docs.github.com/en/actions/security-guides/automatic-token-authentication#about-the-github_token-secret) to your GitHub action |
-| `semver`       | Yes      | The version you want to bump (`patch|minor|major`).                                                                                                                                        |
+| `semver`       | Yes      | The version you want to bump (`auto|patch|minor|major`).                                                                                                                                        |
 | `commit-message`| No      | The commit message template. The keyword `{version}` will be replaced with the new version.  (_Default: `Release {version}`_)                                                              |
 | `npm-token`    | No       | This is your Npm Publish token. Read [how to create](https://docs.npmjs.com/creating-and-viewing-access-tokens#creating-tokens-on-the-website) access tokens. Required only if you want to release to Npm. If you omit this, no Npm release will be published. |
 | `optic-url`    | No       | URL if you have a custom application that serves OTP. <br /> (_Default: <Optic service URL>_)                                                                                              |
@@ -209,6 +214,7 @@ Please note that in case of a prerelease the `sync-semver-tags` input will be tr
 | `artifact-path`| No       | Set this input to the distribution folder or file you want to add as the main asset for your release. It will be downloadable from the release page and a preview of it will be available in the pull request.                                                                  |
 | `version-prefix`       | No       | A prefix to apply to the version number, which reflects in the tag and GitHub release names. <br /> (_Default: 'v'_)                                                                                                                                                                                                                                         |
 | `prerelease-prefix`       | No       | A prefix to apply to the prerelease version number.                                                                                                                                                                                                                                         |
+| `base-tag`       | No       | Base release tag to use for analysing commits when semver `auto` option is enabled.                                                                                                                                                                                                                                         |
 ## Motivation
 
 *Why do I need this when I can create Npm automation tokens?*

action.yml

@@ -72,6 +72,9 @@ inputs:
   prerelease-prefix:
     description: 'A prefix to apply to the prerelease version number'
     required: false
+  base-tag:
+    description: 'Base release tag to use for analysing commits when auto version bump is enabled'
+    required: false
 
 runs:
   using: 'composite'
@@ -86,12 +89,15 @@ runs:
       shell: 'bash'
 
     - name: Version bump
+      uses: actions/github-script@v6
       id: version-bump
       if: ${{ github.event_name == 'workflow_dispatch' }}
-      run: |
-        npm version --no-git-tag-version --preid=${{ inputs.prerelease-prefix }} ${{ inputs.semver }}
-        echo "PACKAGE_VERSION=$(echo $(node -p "require('./package.json').version"))" >> $GITHUB_OUTPUT
-      shell: 'bash'
+      with:
+        result-encoding: string
+        github-token: ${{ inputs.github-token }}
+        script: |
+          const { bumpVersion } = require('${{ github.action_path }}/dist/index.js')
+          return await bumpVersion({ inputs: ${{ toJSON(inputs) }} })
 
     - name: Build the package
       if: ${{ inputs.build-command }}
@@ -107,14 +113,14 @@ runs:
       with:
         github-token: ${{ inputs.github-token }}
         script: |
-          const script = require('${{ github.action_path }}/dist/index.js')
-          await script({ github, context, inputs: ${{ toJSON(inputs) }}, packageVersion: "${{ steps.version-bump.outputs.PACKAGE_VERSION }}" })
+          const { runAction } = require('${{ github.action_path }}/dist/index.js')
+          await runAction({ github, context, inputs: ${{ toJSON(inputs) }}, packageVersion: ${{ steps.version-bump.outputs.result }} })
 
     - name: Release the package
       uses: actions/github-script@v6
       if: ${{ github.event_name == 'pull_request' }}
       with:
         github-token: ${{ inputs.github-token }}
         script: |
-          const script = require('${{ github.action_path }}/dist/index.js')
-          await script({ github, context, inputs: ${{ toJSON(inputs) }} })
+          const { runAction } = require('${{ github.action_path }}/dist/index.js')
+          await runAction({ github, context, inputs: ${{ toJSON(inputs) }} })

dist/commit.hbs

@@ -0,0 +1,30 @@
+*{{#if scope}} **{{scope}}:**
+{{~/if}} {{#if subject}}
+  {{~subject}}
+{{~else}}
+  {{~header}}
+{{~/if}}
+
+{{~!-- commit link --}}{{~#if hash}} {{#if @root.linkReferences~}}
+  ([{{shortHash}}]({{commitUrlFormat}}))
+{{~else}}
+  {{~shortHash}}
+{{~/if}}{{~/if}}
+
+{{~!-- commit references --}}
+{{~#if references~}}
+  , closes
+  {{~#each references}} {{#if @root.linkReferences~}}
+    [
+    {{~#if this.owner}}
+      {{~this.owner}}/
+    {{~/if}}
+    {{~this.repository}}{{this.prefix}}{{this.issue}}]({{issueUrlFormat}})
+  {{~else}}
+    {{~#if this.owner}}
+      {{~this.owner}}/
+    {{~/if}}
+    {{~this.repository}}{{this.prefix}}{{this.issue}}
+  {{~/if}}{{/each}}
+{{~/if}}
+

dist/header.hbs

@@ -0,0 +1,9 @@
+## {{#if @root.linkCompare~}}
+  [{{version}}]({{compareUrlFormat}})
+{{~else}}
+  {{~version}}
+{{~/if}}
+{{~#if title}} "{{title}}"
+{{~/if}}
+{{~#if date}} ({{date}})
+{{/if}}