Automate release on merge in develop

.github/scripts/defineVersion.js

@@ -0,0 +1,57 @@
+const semver = require('semver');
+
+function determinePreReleaseTag(existingVersion, targetReleaseLevel) {
+  const existingPreReleaseVersion = semver.prerelease(existingVersion);
+  if (existingPreReleaseVersion && existingPreReleaseVersion.length > 0) {
+    return `prerelease`;
+  }
+
+  return `pre${targetReleaseLevel}`;
+}
+
+function defineNewVersion(targetReleaseLevel, existingVersion, prereleaseTag) {
+  let releaseTag = targetReleaseLevel;
+
+  if (prereleaseTag) {
+    releaseTag = determinePreReleaseTag(existingVersion, targetReleaseLevel);
+  }
+
+  return semver.inc(existingVersion, releaseTag, prereleaseTag, undefined);
+}
+
+function getPlayerUiVersion(versionInput) {
+  let targetVersion = versionInput ?? process.env.CI_BRANCH;
+
+  if (!targetVersion) {
+    console.log('no version provided using CI_BRANCH');
+    process.exit(1);
+  }
+
+  const playerUiVersion = semver.valid(targetVersion);
+  if (!playerUiVersion) {
+    console.error(`${targetVersion} is not a valid semver`);
+    process.exit(1);
+  }
+
+  return {
+    major: semver.major(playerUiVersion),
+    minor: semver.minor(playerUiVersion),
+    patch: semver.patch(playerUiVersion),
+    prereleaseLabels: semver.prerelease(playerUiVersion),
+    full: playerUiVersion,
+  };
+}
+
+function defineReleaseVersion({ core }, targetReleaseLevel, prereleaseTag, givenVersion) {
+  core.info(
+    `Defining new release version for level ${targetReleaseLevel} and prereleaseTag ${prereleaseTag} given the version ${givenVersion}`,
+  );
+
+  const newVersion = defineNewVersion(targetReleaseLevel, givenVersion, prereleaseTag);
+
+  const parsedPlayerVersion = getPlayerUiVersion(newVersion);
+  core.info(`Using release version ${parsedPlayerVersion.full}`);
+  return parsedPlayerVersion;
+}
+
+module.exports.defineReleaseVersion = defineReleaseVersion;

.github/scripts/updateChangelog.js

@@ -0,0 +1,17 @@
+/**
+ * Updates the changelog by replacing the changelog header with the correct version
+ *
+ * @param {string} changelogString the content of the changelog file
+ * @param {string} version the player version to be released
+ * @param {string} releaseDate the release date to be written to the changelog
+ */
+function updateChangeLog(changelogString, version, releaseDate) {
+    const optionalBetaOrRc = '(-rc.d+)?(-(b|beta).d+)?';
+    const changelogVersionRegExp = new RegExp(
+      `\\[(development|develop|unreleased|${version})${optionalBetaOrRc}.*`,
+      'gi',
+    );
+    return changelogString.replace(changelogVersionRegExp, `[${version}] - ${releaseDate}`);
+  }
+
+  module.exports.updateChangeLog = updateChangeLog;

.github/workflows/merge.yml

@@ -0,0 +1,69 @@
+name: Trigger release on merge
+run-name: Starting release for ${{ github.actor }} PR merge
+on:
+  pull_request:
+    types:
+      - closed
+    branches:
+      - develop
+
+jobs:
+  on_pr_merge:
+    if: github.event.pull_request.merged == true
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout develop
+        uses: actions/checkout@v4
+        with:
+          ref: develop
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Read package.json version
+        uses: actions/github-script@v6
+        id: define-package-json-version
+        with:
+          script: |
+            const { version } = require('./package.json')
+            core.info(`performing a ${{ inputs.release-type }} release for existing version ${version}`)
+            core.setOutput('packageJsonVersion', version)
+
+      - name: Define release version
+        uses: actions/github-script@v6
+        id: define-release-version
+        with:
+          script: |
+            const { defineReleaseVersion } = require('./.github/scripts/defineVersion.js')
+            return defineReleaseVersion({core}, 'minor', undefined, "${{ steps.define-package-json-version.outputs.packageJsonVersion }}" )
+
+      - name: Bump package.json version
+        run: |
+          git config --global user.name 'Automated Release'
+          git config --global user.email '[email protected]'
+          npm version "${{ fromJson(steps.define-release-version.outputs.result).full }}"
+
+      - name: Update Changelog
+        uses: actions/github-script@v6
+        with:
+          script: |
+            const fs = require('fs');
+            const { updateChangeLog } = require('./.github/scripts/updateChangelog.js') 
+
+            const stableVersion = '${{ fromJson(steps.define-release-version.outputs.result).full }}'.split('-')[0]
+            const releaseDate = new Date().toISOString().split('T')[0]
+
+            const data = fs.readFileSync('./CHANGELOG.md',{encoding:'utf8', flag:'r'});
+
+            core.info(`Updating ${stableVersion} with date ${releaseDate} in Changelog`);
+
+            const changelogFileContents = updateChangeLog(data, stableVersion, releaseDate);
+
+            fs.writeFileSync('./CHANGELOG.md', changelogFileContents, 'utf-8');
+
+      - name: Push changes
+        run: |
+          git add .
+          git commit -m "Bump version ${{ fromJson(steps.define-release-version.outputs.result).full }} and update changelog"
+          git push origin develop
+          git push origin --tags

package.json

@@ -49,6 +49,7 @@
     "merge2": "^1.4.1",
     "postcss-svg": "^3.0.0",
     "sass": "^1.59.3",
+    "semver": "^7.5.4",
     "stream-combiner2": "^1.1.1",
     "ts-jest": "^29.0.5",
     "tsify": "^5.0.4",
@@ -59,4 +60,4 @@
     "watchify": "^4.0.0",
     "yargs": "^17.7.1"
   }
-}
+}

spec/release/defineVersion.spec.ts

@@ -0,0 +1,31 @@
+const { defineReleaseVersion } = require('../../.github/scripts/defineVersion');
+
+describe('defineReleaseVersion', () => {
+  test.each`
+    existingVersion   | desiredReleaseLevel | preReleaseTag | expectedVersion
+    ${'1.0.0'}        | ${'major'}          | ${undefined}  | ${'2.0.0'}
+    ${'1.0.0'}        | ${'minor'}          | ${undefined}  | ${'1.1.0'}
+    ${'1.1.0'}        | ${'minor'}          | ${undefined}  | ${'1.2.0'}
+    ${'1.0.0'}        | ${'patch'}          | ${undefined}  | ${'1.0.1'}
+    ${'1.1.0'}        | ${'patch'}          | ${undefined}  | ${'1.1.1'}
+    ${'1.0.4'}        | ${'patch'}          | ${undefined}  | ${'1.0.5'}
+    ${'1.0.0'}        | ${'minor'}          | ${'rc'}       | ${'1.1.0-rc.0'}
+    ${'1.1.0-rc.0'}   | ${'minor'}          | ${undefined}  | ${'1.1.0'}
+    ${'1.0.0'}        | ${'minor'}          | ${'beta'}     | ${'1.1.0-beta.0'}
+    ${'1.1.0-beta.0'} | ${'minor'}          | ${'beta'}     | ${'1.1.0-beta.1'}
+    ${'1.1.0-beta.5'} | ${'minor'}          | ${'beta'}     | ${'1.1.0-beta.6'}
+    ${'1.0.0'}        | ${'major'}          | ${'beta'}     | ${'2.0.0-beta.0'}
+    ${'1.5.0'}        | ${'major'}          | ${'beta'}     | ${'2.0.0-beta.0'}
+    ${'1.5.0'}        | ${'major'}          | ${'rc'}       | ${'2.0.0-rc.0'}
+    ${'2.0.0-beta.0'} | ${'major'}          | ${'rc'}       | ${'2.0.0-rc.0'}
+    ${'2.0.0-rc.1'}   | ${'major'}          | ${undefined}  | ${'2.0.0'}
+  `(
+    'should return version $expectedVersion with version $existingVersion and $desiredReleaseLevel release level',
+    ({ existingVersion, desiredReleaseLevel, preReleaseTag, expectedVersion }) => {
+      const core = { info() {} };
+      const result = defineReleaseVersion({ core }, desiredReleaseLevel, preReleaseTag, existingVersion);
+
+      expect(result.full).toEqual(expectedVersion);
+    },
+  );
+});