Auto version bump

.github/workflows/release.yml

@@ -9,6 +9,7 @@ on:
         default: 'patch'
         type: choice
         options:
+          - auto
           - patch
           - minor
           - major

README.md

@@ -37,6 +37,7 @@ on:
         default: "patch"
         type: choice
         options:
+          - auto
           - patch
           - minor
           - major
@@ -84,6 +85,9 @@ 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.
+
 ## 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.

action.yml

@@ -83,12 +83,19 @@ 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 ${{ inputs.semver }}
-        echo "PACKAGE_VERSION=$(echo $(node -p "require('./package.json').version"))" >> $GITHUB_OUTPUT
-      shell: 'bash'
+      if: github.event_name == 'workflow_dispatch'
+      with:
+        github-token: ${{ inputs.github-token }}
+        script: |
+          let newVersion = '${{ inputs.semver }}'
+          if ('${{ inputs.semver }}' == 'auto') {
+            const script = require('${{ github.action_path }}/dist/index.js')
+            newVersion = await script.getBumpedVersion({ github, context })
+          }
+          await exec.exec(`npm version --no-git-tag-version ${newVersion}`)
+          return require('./package.json').version
 
     - name: Build the package
       if: ${{ inputs.build-command }}
@@ -105,7 +112,7 @@ runs:
         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 }}" })
+          await script({ github, context, inputs: ${{ toJSON(inputs) }}, packageVersion: ${{ steps.version-bump.outputs.result }} })
 
     - name: Release the package
       uses: actions/github-script@v6

dist/index.js

@@ -26847,6 +26847,7 @@ exports.APP_NAME = 'optic-release-automation[bot]'
 
 const openPr = __nccwpck_require__(1515)
 const release = __nccwpck_require__(2026)
+const { getBumpedVersion } = __nccwpck_require__(7292)
 const { logError } = __nccwpck_require__(653)
 
 module.exports = async function ({ github, context, inputs, packageVersion }) {
@@ -26861,6 +26862,8 @@ module.exports = async function ({ github, context, inputs, packageVersion }) {
   logError('Unsupported event')
 }
 
+module.exports.getBumpedVersion = getBumpedVersion
+
 
 /***/ }),
 
@@ -27299,6 +27302,177 @@ const deriveFilename = (filePath, extension) => {
 exports.attach = attach
 
 
+/***/ }),
+
+/***/ 7292:
+/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
+
+"use strict";
+
+
+const semver = __nccwpck_require__(1383)
+
+async function getBumpedVersion({ github, context }) {
+  const { owner, repo } = context.repo
+
+  const {
+    latestReleaseCommitSha,
+    latestReleaseTagName,
+    latestReleaseCommitDate,
+  } = await getLatestRelease({ github, owner, repo })
+
+  if (
+    !latestReleaseCommitSha ||
+    !latestReleaseTagName ||
+    !latestReleaseCommitDate
+  ) {
+    throw new Error(`Couldn't find latest release`)
+  }
+
+  const allCommits = await getCommitMessagesSinceLatestRelease({
+    github,
+    owner,
+    repo,
+    commitDate: latestReleaseCommitDate,
+  })
+
+  if (!allCommits.length) {
+    throw new Error(`No commits found since last release`)
+  }
+
+  const bumpedVersion = getVersionFromCommits(latestReleaseTagName, allCommits)
+
+  if (!semver.valid(bumpedVersion)) {
+    throw new Error(`Invalid bumped version ${bumpedVersion}`)
+  }
+  return bumpedVersion
+}
+
+function getVersionFromCommits(currentVersion, commits = []) {
+  // Define a regular expression to match Conventional Commits messages
+  const commitRegex = /^(feat|fix|BREAKING CHANGE)(\(.+\))?:(.+)$/
+
+  // Define a mapping of commit types to version bump types
+  var versionBumpMap = {
+    'BREAKING CHANGE': 'major',
+    feat: 'minor',
+    fix: 'patch',
+  }
+
+  let { major, minor, patch } = semver.parse(currentVersion)
+
+  if (
+    !Number.isInteger(major) ||
+    !Number.isInteger(minor) ||
+    !Number.isInteger(patch)
+  ) {
+    throw new Error('Invalid major/minor/patch version found')
+  }
+
+  let isBreaking = false
+  let isMinor = false
+
+  for (const commit of commits) {
+    const match = commitRegex.exec(commit)
+    if (!match) continue
+
+    const type = match[1]
+
+    const bumpType = versionBumpMap[type]
+    if (!bumpType) continue
+
+    if (bumpType === 'major') {
+      isBreaking = true
+      break
+    } else if (bumpType === 'minor') {
+      isMinor = true
+    }
+  }
+
+  if (isBreaking) {
+    return `${++major}.0.0`
+  } else if (isMinor) {
+    return `${major}.${++minor}.0`
+  } else {
+    return `${major}.${minor}.${++patch}`
+  }
+}
+
+async function getLatestRelease({ github, owner, repo }) {
+  const data = await github.graphql(
+    `
+    query getLatestTagCommit($owner: String!, $repo: String!) {
+      repository(owner: $owner, name: $repo) {
+        latestRelease{
+          tagName
+          tagCommit {
+            oid
+            committedDate
+          }
+        }
+      }
+    }
+    `,
+    {
+      owner,
+      repo,
+    }
+  )
+
+  const latestReleaseCommitSha = data?.repository?.latestRelease?.tagCommit?.oid
+  const latestReleaseTagName = data?.repository?.latestRelease?.tagName
+  const latestReleaseCommitDate =
+    data?.repository?.latestRelease?.tagCommit?.committedDate
+
+  return {
+    latestReleaseCommitSha,
+    latestReleaseTagName,
+    latestReleaseCommitDate,
+  }
+}
+
+async function getCommitMessagesSinceLatestRelease({
+  github,
+  owner,
+  repo,
+  commitDate,
+}) {
+  const parsedCommitDate = new Date(commitDate)
+  parsedCommitDate.setSeconds(parsedCommitDate.getSeconds() + 1)
+
+  const data = await github.graphql(
+    `
+      query getCommitsSinceLastRelease($owner: String!, $repo: String!, $since: GitTimestamp!) {
+        repository(owner: $owner, name: $repo) {
+          defaultBranchRef {
+            target {
+              ... on Commit {
+                history(first: 100, since: $since) {
+                  nodes {
+                    message
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    `,
+    {
+      owner,
+      repo,
+      since: parsedCommitDate,
+    }
+  )
+
+  const commitsList =
+    data?.repository?.defaultBranchRef?.target?.history?.nodes || []
+  return commitsList.map(c => c.message)
+}
+
+exports.getBumpedVersion = getBumpedVersion
+
+
 /***/ }),
 
 /***/ 4235:

src/index.js

@@ -2,6 +2,7 @@
 
 const openPr = require('./openPr')
 const release = require('./release')
+const { getBumpedVersion } = require('./utils/bump')
 const { logError } = require('./log')
 
 module.exports = async function ({ github, context, inputs, packageVersion }) {
@@ -15,3 +16,5 @@ module.exports = async function ({ github, context, inputs, packageVersion }) {
 
   logError('Unsupported event')
 }
+
+module.exports.getBumpedVersion = getBumpedVersion