Add known branch exceptions to version matching (#242)

* Do a bit of YAMLlint'ing

* Ease consumer cache invalidation

By providing an output with the action version we ease
cache invalidation on consumer, due to the fact we can
now stop worrying about changes to the action's cache itself

Might also be interesting for self-hosted runners...

* Remove duplicates

* Do further validations for robustness

.github/workflows/action.yml

@@ -7,9 +7,30 @@ env:
   GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
 
 jobs:
+  version:
+    name: Version with commit unique id
+    runs-on: ubuntu-latest
+    if: github.ref == 'refs/heads/main'
+    steps:
+      - uses: actions/checkout@v3
+      - name: Version it!
+        run: |
+          # We expect a string such as const setupBeamVersion = 'undefined' in the code
+          SHA=$(git rev-parse --short HEAD)
+          sed -i'.bak' \
+              -e "s/const setupBeamVersion = '.*'/const setupBeamVersion = '${SHA}'/g" \
+              src/setup-beam.js
+          npm run build-dist
+          git config user.name "GitHub Actions"
+          git config user.email "actions@user.noreply.github.com"
+          git add src/setup-beam.js
+          git add dist/index.js
+          git commit -m "Automation: update setup-beam version output to ${SHA}"
+          git push origin main
   check_integrity:
     name: Expected local npm actions
     runs-on: ubuntu-latest
+    if: github.ref != 'refs/heads/main'
     steps:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3

.github/workflows/ubuntu.yml

@@ -24,7 +24,7 @@ jobs:
             os: 'ubuntu-latest'
             version-type: 'strict'
           - otp-version: '25.2'
-            elixir-version: '1.14.3'
+            elixir-version: '1.14.2'
             os: 'ubuntu-latest'
           - otp-version: '25.2'
             elixir-version: '1.14.3'
@@ -66,14 +66,6 @@ jobs:
             otp-version: '21'
             rebar3-version: '3.12'
             os: 'ubuntu-20.04'
-          - elixir-version: 'v1.6'
-            otp-version: '21'
-            rebar3-version: '3.12'
-            os: 'ubuntu-20.04'
-          - elixir-version: 'v1.7'
-            otp-version: '22'
-            rebar3-version: '3.13'
-            os: 'ubuntu-20.04'
           - elixir-version: 'v1.7'
             otp-version: '22'
             rebar3-version: '3.13'
@@ -86,18 +78,10 @@ jobs:
             otp-version: '25.0.2'
             rebar3-version: '3.19'
             os: 'ubuntu-20.04'
-          - elixir-version: 'v1.10'
-            otp-version: '23'
-            rebar3-version: '3.14'
-            os: 'ubuntu-20.04'
           - elixir-version: 'v1.12'
             otp-version: '24'
             rebar3-version: '3.15'
             os: 'ubuntu-20.04'
-          - elixir-version: 'v1.13.4'
-            otp-version: '25.0.2'
-            rebar3-version: '3.19'
-            os: 'ubuntu-20.04'
           - elixir-version: 'v1.11.0'
             otp-version: '22.3.4.2'
             os: 'ubuntu-20.04'
@@ -108,11 +92,11 @@ jobs:
             version-type: 'strict'
           - elixir-version: 'main'
             otp-version: '23.1'
-            os:  'ubuntu-20.04'
+            os: 'ubuntu-20.04'
             version-type: 'strict'
           - elixir-version: 'main'
             otp-version: '25'
-            os:  'ubuntu-20.04'
+            os: 'ubuntu-20.04'
             version-type: 'strict'
           - gleam-version: '0.23'
             otp-version: '24'
@@ -126,7 +110,7 @@ jobs:
             otp-version: false
             os: 'ubuntu-latest'
             disable_problem_matchers: true
-          - gleam-version: '0.22.0' # Version with Gleam's old archive naming convention
+          - gleam-version: '0.22.0'  # Version with Gleam's old archive naming convention
             otp-version: '24'
             os: 'ubuntu-latest'
             disable_problem_matchers: true

README.md

@@ -88,6 +88,21 @@ jobs:
         ...
 ```
 
+### Outputs
+
+The action provides the following outputs:
+
+| Output             | Content
+|-                   |-
+| otp-version        | The Erlang version, e.g. `OTP-26.0`
+| elixir-version     | The Elixir version, e.g. `v1.14-otp-26`
+| gleam-version      | The Gleam version, e.g. `v0.23.0`
+| rebar3-version     | The `rebar3` version, e.g. `3.18.0`
+| setup-beam-version | The commit unique id of the executed action version, e.g. `a34c98f`
+
+accessible as `${{steps.<setup-beam-step-id>.outputs.<Output>}}`,
+e.g. `${{steps.setup-beam.outputs.erlang-version}}`
+
 ### Version file
 
 A version file is specified via input `version-file` (e.g.`.tool-versions`). This

action.yml

@@ -58,6 +58,8 @@ outputs:
     description: Exact version of Gleam that was installed
   rebar3-version:
     description: Exact version of rebar3 that was installed
+  setup-beam-version:
+    description: The commit unique id of the execution action version
 runs:
   using: node16
   main: dist/index.js

dist/index.js

@@ -6161,7 +6161,7 @@ class Range {
     this.set = this.raw
       .split('||')
       // map the range to a 2d array of comparators
-      .map(r => this.parseRange(r))
+      .map(r => this.parseRange(r.trim()))
       // throw out any comparator lists that are empty
       // this generally means that it was not a valid range, which is allowed
       // in loose mode, but will still throw if the WHOLE range is invalid.
@@ -7633,7 +7633,11 @@ module.exports = parseOptions
 /***/ 9523:
 /***/ ((module, exports, __nccwpck_require__) => {
 
-const { MAX_SAFE_COMPONENT_LENGTH, MAX_SAFE_BUILD_LENGTH } = __nccwpck_require__(2293)
+const {
+  MAX_SAFE_COMPONENT_LENGTH,
+  MAX_SAFE_BUILD_LENGTH,
+  MAX_LENGTH,
+} = __nccwpck_require__(2293)
 const debug = __nccwpck_require__(427)
 exports = module.exports = {}
 
@@ -7654,7 +7658,7 @@ const LETTERDASHNUMBER = '[a-zA-Z0-9-]'
 // all input should have extra whitespace removed.
 const safeRegexReplacements = [
   ['\\s', 1],
-  ['\\d', MAX_SAFE_COMPONENT_LENGTH],
+  ['\\d', MAX_LENGTH],
   [LETTERDASHNUMBER, MAX_SAFE_BUILD_LENGTH],
 ]
 
@@ -9868,6 +9872,10 @@ async function main() {
 
   await maybeInstallGleam(gleamSpec)
   await maybeInstallRebar3(rebar3Spec)
+
+  // undefined is replaced by a function, post- main branch merge
+  const setupBeamVersion = 'bc84950'
+  core.setOutput('setup-beam-version', setupBeamVersion)
 }
 
 async function installOTP(otpSpec, osVersion) {
@@ -10216,7 +10224,7 @@ function getVersionFromSpec(spec0, versions0) {
   const rangeMax = semver.maxSatisfying(versions, rangeForMax)
   let version = null
 
-  if (isStrictVersion() || isRC(spec0)) {
+  if (isStrictVersion() || isRC(spec0) || isKnownBranch(spec0)) {
     if (versions0[spec]) {
       // If `version-type: strict` or version is RC, we obtain it directly
       version = versions0[spec]
@@ -10288,6 +10296,10 @@ function isRC(ver) {
   return ver.match(xyzAbcVersion('^', '(?:-rc\\.?\\d+)'))
 }
 
+function isKnownBranch(ver) {
+  return ['main', 'master', 'maint'].includes(ver)
+}
+
 function getRunnerOSVersion() {
   const ImageOSToContainer = {
     ubuntu18: 'ubuntu-18.04',

package-lock.json

@@ -11,7 +11,7 @@
         "@actions/exec": "1.1.1",
         "@actions/http-client": "2.1.0",
         "@actions/tool-cache": "2.0.1",
-        "semver": "7.5.3"
+        "semver": "7.5.4"
       },
       "devDependencies": {
         "@vercel/ncc": "0.36.1",
@@ -2290,9 +2290,9 @@
       }
     },
     "node_modules/semver": {
-      "version": "7.5.3",
-      "resolved": "https://registry.npmjs.org/semver/-/semver-7.5.3.tgz",
-      "integrity": "sha512-QBlUtyVk/5EeHbi7X0fw6liDZc7BBmEaSYn01fMU1OUYbf6GPsbTtd8WmnqbI20SeycoHSeiybkE/q1Q+qlThQ==",
+      "version": "7.5.4",
+      "resolved": "https://registry.npmjs.org/semver/-/semver-7.5.4.tgz",
+      "integrity": "sha512-1bCSESV6Pv+i21Hvpxp3Dx+pSD8lIPt8uVjRrxAUt/nbswYc+tK6Y2btiULjd4+fnq15PX+nqQDC7Oft7WkwcA==",
       "dependencies": {
         "lru-cache": "^6.0.0"
       },

package.json

@@ -18,7 +18,7 @@
     "@actions/exec": "1.1.1",
     "@actions/http-client": "2.1.0",
     "@actions/tool-cache": "2.0.1",
-    "semver": "7.5.3"
+    "semver": "7.5.4"
   },
   "devDependencies": {
     "@vercel/ncc": "0.36.1",

src/setup-beam.js

@@ -47,6 +47,10 @@ async function main() {
 
   await maybeInstallGleam(gleamSpec)
   await maybeInstallRebar3(rebar3Spec)
+
+  // undefined is replaced by a function, post- main branch merge
+  const setupBeamVersion = 'bc84950'
+  core.setOutput('setup-beam-version', setupBeamVersion)
 }
 
 async function installOTP(otpSpec, osVersion) {
@@ -400,7 +404,7 @@ function getVersionFromSpec(spec0, versions0) {
   const rangeMax = semver.maxSatisfying(versions, rangeForMax)
   let version = null
 
-  if (isStrictVersion() || isRC(spec0)) {
+  if (isStrictVersion() || isRC(spec0) || isKnownBranch(spec0)) {
     if (versions0[spec]) {
       // If `version-type: strict` or version is RC, we obtain it directly
       version = versions0[spec]
@@ -472,6 +476,10 @@ function isRC(ver) {
   return ver.match(xyzAbcVersion('^', '(?:-rc\\.?\\d+)'))
 }
 
+function isKnownBranch(ver) {
+  return ['main', 'master', 'maint'].includes(ver)
+}
+
 function getRunnerOSVersion() {
   const ImageOSToContainer = {
     ubuntu18: 'ubuntu-18.04',

test/setup-beam.test.js

@@ -182,6 +182,18 @@ async function testOTPVersions() {
     expected = 'OTP-20.0.5'
     got = await setupBeam.getOTPVersion(spec, osVersion)
     assert.deepStrictEqual(got, expected)
+
+    spec = 'maint'
+    osVersion = 'ubuntu-22.04'
+    expected = 'maint'
+    got = await setupBeam.getOTPVersion(spec, osVersion, hexMirrors)
+    assert.deepStrictEqual(got, expected)
+
+    spec = 'master'
+    osVersion = 'ubuntu-22.04'
+    expected = 'master'
+    got = await setupBeam.getOTPVersion(spec, osVersion, hexMirrors)
+    assert.deepStrictEqual(got, expected)
   }
 
   if (process.platform === 'win32') {