Automation: update setup-beam version output to 98c13a9

* add support for mise.toml version file type

* changes from review

* Keep versioning consistent

* fix default value for version-file-type input

* Use single `version-file`, autodetect type

* Update src/setup-beam.js

Co-authored-by: Paulo F. Oliveira <paulo.ferraz.oliveira@gmail.com>

* Improve log output for mise version files

* Rebuild dist

* Run build-dist

* add support for mise.toml version file type

* changes from review

* Keep versioning consistent

* fix default value for version-file-type input

* Use single `version-file`, autodetect type

* Update src/setup-beam.js

Co-authored-by: Paulo F. Oliveira <paulo.ferraz.oliveira@gmail.com>

* Improve log output for mise version files

* Rebuild dist

* Run build-dist

---------

Co-authored-by: Michael Ruoss <michael.ruoss@cradle.bio>
Co-authored-by: Michael Ruoss <michael@michaelruoss.ch>
Co-authored-by: Paulo F. Oliveira <paulo.ferraz.oliveira@gmail.com>

.github/workflows/action.yml

@@ -46,7 +46,7 @@ jobs:
     if: github.ref != 'refs/heads/main'
     steps:
       - uses: actions/checkout@v6.0.2
-      - uses: actions/setup-node@v6.1.0
+      - uses: actions/setup-node@v6.3.0
         with:
           node-version: '20'
       - run: npm run build-dist
@@ -59,18 +59,20 @@ jobs:
     if: github.ref != 'refs/heads/main'
     steps:
       - uses: actions/checkout@v6.0.2
-      - uses: raven-actions/actionlint@v2.1.0
+      - uses: raven-actions/actionlint@v2.1.2
 
   unit_tests_ubuntu:
     name: Unit tests (Ubuntu)
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v6.0.2
-      - uses: actions/setup-node@v6.1.0
+      - uses: actions/setup-node@v6.3.0
         with:
           node-version: '20'
       - run: npm ci
       - run: npm test
+        env:
+          NODE_ENV: test
       - name: .tool-versions test
         id: setup-beam
         uses: ./
@@ -85,11 +87,13 @@ jobs:
     runs-on: windows-latest
     steps:
       - uses: actions/checkout@v6.0.2
-      - uses: actions/setup-node@v6.1.0
+      - uses: actions/setup-node@v6.3.0
         with:
           node-version: '20'
       - run: npm install --production
       - run: npm test
+        env:
+          NODE_ENV: test
       - name: .tool-versions test
         id: setup-beam
         uses: ./
@@ -104,8 +108,10 @@ jobs:
     runs-on: macos-latest
     steps:
       - uses: actions/checkout@v6.0.2
-      - uses: actions/setup-node@v6.1.0
+      - uses: actions/setup-node@v6.3.0
         with:
           node-version: '20'
       - run: npm ci
       - run: npm test
+        env:
+          NODE_ENV: test

.github/workflows/update_3rd_party_licenses.yml

@@ -3,6 +3,7 @@ name: Update 3rd party licenses (automation)
 
 permissions:
   contents: write
+  pull-requests: write
 
 on:
   schedule:

.gitignore

@@ -1,2 +1,4 @@
-node_modules/**
+/node_modules
-test/.tool-versions
+/test/.tool-versions
+/test/mise.toml
+/dist/package.json

README.md

@@ -141,23 +141,22 @@ e.g. `${{steps.setup-beam.outputs.erlang-version}}`
 
 ### Version file
 
-A version file is specified via input `version-file` (e.g.`.tool-versions`). This
+A version file is specified via input `version-file` (e.g. `.tool-versions` or `mise.toml`).
-allows not having to use YML input for versions, though the action does check (and
+The file type is inferred from the filename: files ending in `.toml` are parsed as
+[mise](https://mise.jdx.dev/configuration.html#tools-dev-tools) configuration, and all others
+are parsed as [`.tool-versions`](https://asdf-vm.com/manage/configuration.html) (asdf format).
+This allows not having to use YML input for versions, though the action does check (and
 will exit with error) if both inputs are set.
 
 **Note**: if you're using a version file, option `version-type` is checked to be `strict`,
 and will make the action exit with error otherwise.
 
-The following version file formats are supported:
-
-- `.tool-versions`, as specified by [asdf: Configuration](https://asdf-vm.com/manage/configuration.html)
-
 Supported version elements are the same as the ones defined for the YML portion of the action,
 with the following correspondence.
 
-#### `.tool-versions` format
+#### `.tool-versions` / `mise.toml` format
 
-| YML              | `.tool-versions`
+| YML              | Version file key
 |-                 |-
 | `otp-version`    | `erlang`
 | `elixir-version` | `elixir`

action.yml

@@ -69,7 +69,9 @@ inputs:
     required: false
 
   version-file:
-    description: a versions file (e.g. as used by `asdf`), which defines inputs
+    description: >-
+      a versions file (e.g. `.tool-versions` as used by `asdf`, or `mise.toml`
+      as used by `mise`), which defines inputs
     default: ''
     required: false
 

eslint.config.mjs

@@ -1,30 +1,27 @@
 import js from '@eslint/js'
 import globals from 'globals'
-import { defineConfig } from 'eslint/config'
+import yml from 'eslint-plugin-yml'
-import eslintPluginYml from 'eslint-plugin-yml'
+import * as yamlParser from 'yaml-eslint-parser'
 
-export default defineConfig([
+export default [
-  ...eslintPluginYml.configs['flat/recommended'],
+  js.configs.recommended,
   {
-    extends: ['js/recommended'],
+    languageOptions: {
+      ecmaVersion: 'latest',
+      sourceType: 'module',
+      globals: globals.node,
+    },
+  },
+  {
+    files: ['**/*.yml'],
+    languageOptions: {
+      parser: yamlParser,
+    },
     plugins: {
-      js,
+      yml,
     },
-    languageOptions: {
+    rules: {
-      ecmaVersion: 2022,
+      ...yml.configs.recommended.rules,
-      globals: {
-        ...globals.node,
-      },
     },
   },
-  {
+]
-    extends: eslintPluginYml.configs['flat/recommended'],
-    files: ['*.yml'],
-    languageOptions: {
-      parserOptions: {
-        parser: 'yaml-eslint-parser',
-        defaultYAMLVersion: '1.2',
-      },
-    },
-  },
-])

package.json

@@ -1,5 +1,6 @@
 {
   "name": "setup-beam",
+  "type": "module",
   "license": "MIT",
   "private": true,
   "scripts": {
@@ -16,21 +17,22 @@
     "build-dist": "npm run clean-dist && npm install && npm run build && npm run format && npm run lint"
   },
   "dependencies": {
-    "@actions/core": "1.11.1",
+    "@actions/core": "3.0.0",
-    "@actions/exec": "1.1.1",
+    "@actions/exec": "3.0.0",
-    "@actions/tool-cache": "2.0.2",
+    "@actions/tool-cache": "4.0.0",
     "csv-parse": "6.1.0",
     "lodash": "4.17.23",
-    "semver": "7.7.2"
+    "semver": "7.7.4",
+    "toml": "3.0.0"
   },
   "devDependencies": {
-    "@eslint/js": "9.38.0",
+    "@eslint/js": "10.0.1",
     "@vercel/ncc": "0.38.4",
-    "eslint": "9.38.0",
+    "eslint": "10.0.3",
-    "eslint-plugin-yml": "1.18.0",
+    "eslint-plugin-yml": "3.3.1",
-    "globals": "17.3.0",
+    "globals": "17.4.0",
-    "markdownlint-cli": "0.47.0",
+    "markdownlint-cli": "0.48.0",
-    "prettier": "3.6.2",
+    "prettier": "3.8.1",
     "shellcheck": "4.1.0",
     "yarn": "1.22.22"
   },

src/setup-beam.js

@@ -1,14 +1,19 @@
-const core = require('@actions/core')
+import path from 'node:path'
-const { exec } = require('@actions/exec')
+import fs from 'node:fs'
-const tc = require('@actions/tool-cache')
+import os from 'node:os'
-const path = require('path')
+import { fileURLToPath } from 'node:url'
-const semver = require('semver')
+import * as core from '@actions/core'
-const fs = require('fs')
+import { exec } from '@actions/exec'
-const os = require('os')
+import * as tc from '@actions/tool-cache'
-const csv = require('csv-parse/sync')
+import * as semver from 'semver'
-const _ = require('lodash')
+import * as csv from 'csv-parse/sync'
+import _ from 'lodash'
+import toml from 'toml'
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url))
 
 const MAX_HTTP_RETRIES = 3
+const APPS = ['erlang', 'elixir', 'gleam', 'rebar']
 
 if (process.env.NODE_ENV !== 'test') {
   main().catch((err) => {
@@ -53,7 +58,7 @@ async function main() {
   await maybeInstallRebar3(rebar3Spec)
 
   // undefined is replaced by a function, post- main branch merge
-  const setupBeamVersion = 'fe5485f'
+  const setupBeamVersion = '98c13a9'
   core.setOutput('setup-beam-version', setupBeamVersion)
 }
 
@@ -108,11 +113,9 @@ async function maybeInstallElixir(elixirSpec) {
 function maybeEnableElixirProblemMatchers() {
   const disableProblemMatchers = getInput('disable_problem_matchers', false)
   if (disableProblemMatchers === 'false') {
+    // path.join helps ncc figure this out
     const elixirMatchers = path.join(
-      __dirname,
+      `${__dirname}/../matchers/elixir-matchers.json`,
-      '..',
-      'matchers',
-      'elixir-matchers.json',
     )
     core.info(`##[add-matcher]${elixirMatchers}`)
   }
@@ -191,17 +194,17 @@ async function getOTPVersion(otpSpec0, osVersion) {
 }
 
 function requestedVersionFor(tool, version, originListing, mirrors) {
-  const isStrictVersion = isStrictVersion()
+  const isVersionTypeStrict = isStrictVersion()
 
   let versionType = 'loose'
-  if (isStrictVersion) {
+  if (isVersionTypeStrict) {
     versionType = 'strict'
   }
 
   let ret =
     `Requested ${versionType} ${tool} version (${version}) not found in version list, ` +
     `at ${originListing}${mirrors ? `, with mirrors ${mirrors}` : ''}.`
-  if (!isStrictVersion) {
+  if (!isVersionTypeStrict) {
     ret = `${ret} Should you be using option 'version-type': 'strict'?`
   }
 
@@ -576,7 +579,7 @@ function getVersionFromSpec(spec0, versions0) {
 }
 
 function maybeCoerced(v) {
-  let ret = null
+  let ret
   try {
     if (!isRC(v)) {
       ret = semver.coerce(v).version
@@ -801,28 +804,14 @@ alongside ${alternativeName}=${alternativeValue} \
   return input
 }
 
-function parseVersionFile(versionFilePath0) {
+function parseToolVersionsFile(versionFilePath) {
-  const versionFilePath = path.resolve(
-    process.env.GITHUB_WORKSPACE,
-    versionFilePath0,
-  )
-  if (!fs.existsSync(versionFilePath)) {
-    throw new Error(
-      `The specified version file, ${versionFilePath0}, does not exist`,
-    )
-  }
-
-  core.startGroup(`Parsing version file at ${versionFilePath0}`)
   const appVersions = new Map()
   const versions = fs.readFileSync(versionFilePath, 'utf8')
-  // For the time being we parse .tool-versions
-  // If we ever start parsing something else, this should
-  // become default in a new option named e.g. version-file-type
   versions.split(/\r?\n/).forEach((line) => {
     const appVersion = line.match(/^([^ ]+)[ ]+(ref:v?)?([^ #]+)/)
     if (appVersion) {
       const app = appVersion[1]
-      if (['erlang', 'elixir', 'gleam', 'rebar'].includes(app)) {
+      if (APPS.includes(app)) {
         const [, , , version] = appVersion
         core.info(`Consuming ${app} at version ${version}`)
         appVersions.set(app, version)
@@ -839,6 +828,46 @@ function parseVersionFile(versionFilePath0) {
   return appVersions
 }
 
+function parseMiseTomlFile(versionFilePath) {
+  const appVersions = new Map()
+  const miseToml = fs.readFileSync(versionFilePath, 'utf8')
+  const miseTomlParsed = toml.parse(miseToml)
+  for (const app in miseTomlParsed.tools) {
+    if (APPS.includes(app)) {
+      const appVersion = miseTomlParsed.tools[app]
+      const version =
+        typeof appVersion == 'object' ? appVersion.version : appVersion
+
+      core.info(`Consuming ${app} at version ${version}`)
+      appVersions.set(app, version)
+    }
+  }
+
+  return appVersions
+}
+
+function parseVersionFile(versionFilePath0) {
+  const versionFilePath = path.resolve(
+    process.env.GITHUB_WORKSPACE,
+    versionFilePath0,
+  )
+  if (!fs.existsSync(versionFilePath)) {
+    throw new Error(
+      `The specified version file, ${versionFilePath0}, does not exist`,
+    )
+  }
+
+  if (versionFilePath0.endsWith('.toml')) {
+    core.startGroup(
+      `Parsing ${path.basename(versionFilePath0)} file at ${versionFilePath0}`,
+    )
+    return parseMiseTomlFile(versionFilePath)
+  }
+
+  core.startGroup(`Parsing .tool-versions file at ${versionFilePath0}`)
+  return parseToolVersionsFile(versionFilePath)
+}
+
 function debugLog(groupName, message) {
   const group = `Debugging for ${groupName}`
   core.debug(
@@ -1237,7 +1266,7 @@ function debugLoggingEnabled() {
   return !!process.env.RUNNER_DEBUG
 }
 
-module.exports = {
+export default {
   get,
   getElixirVersion,
   getGleamVersion,

test/setup-beam.test.js

@@ -9,15 +9,16 @@ simulateInput('install-hex', 'true')
 simulateInput('github-token', process.env.GITHUB_TOKEN)
 simulateInput('hexpm-mirrors', 'https://builds.hex.pm', { multiline: true })
 
-const assert = require('assert')
+import assert from 'node:assert'
-const http = require('http')
+import http from 'node:http'
-const fs = require('fs')
+import fs from 'node:fs'
-const os = require('os')
+import os from 'node:os'
-const path = require('path')
+import path from 'node:path'
-const setupBeam = require('../src/setup-beam')
+import { describe, it } from 'node:test'
-const { problemMatcher } = require('../matchers/elixir-matchers.json')
+import * as csv from 'csv-parse/sync'
-const { describe, it } = require('node:test')
+import setupBeam from '../src/setup-beam.js'
-const csv = require('csv-parse/sync')
+import elixirMatchers from '../matchers/elixir-matchers.json' with { type: 'json' }
+const { problemMatcher } = elixirMatchers
 
 const matrix = {
   otp: {
@@ -968,7 +969,7 @@ describe('.getVersionFromSpec(_)', () => {
   })
 })
 
-describe('version file', () => {
+describe('.tool-versions file', () => {
   const otpVersion = unsimulateInput('otp-version')
   const elixirVersion = unsimulateInput('elixir-version')
   const gleamVersion = unsimulateInput('gleam-version')
@@ -1017,6 +1018,55 @@ gleam ${gleam} \n`
   simulateInput('gleam-version', gleamVersion)
 })
 
+describe('mise.toml file', () => {
+  const otpVersion = unsimulateInput('otp-version')
+  const elixirVersion = unsimulateInput('elixir-version')
+  const gleamVersion = unsimulateInput('gleam-version')
+
+  it('is parsed correctly', async () => {
+    const erlang = '27.3.4.1'
+    const elixir = '1.18.4'
+    const gleam = '1.9.1'
+    let miseToml = `[tools]
+"erlang" = "${erlang}"
+elixir = { version = "${elixir}", postinstall="mix deps.get" }  # comment, with space and ref:
+"not-gleam" = 0.23 # not picked up
+"gleam" = "${gleam}" \n`
+    const filename = 'test/mise.toml'
+    if (process.platform === 'win32') {
+      // Force \r\n to test in Windows
+      miseToml = miseToml.replace(/\n/g, '\r\n')
+    }
+    fs.writeFileSync(filename, miseToml)
+    process.env.GITHUB_WORKSPACE = ''
+    const appVersions = setupBeam.parseVersionFile(filename)
+    assert.strictEqual(appVersions.get('erlang'), erlang)
+    assert.strictEqual(appVersions.get('elixir'), elixir)
+
+    const absoluteFilename = path.join(os.tmpdir(), 'mise.toml')
+    fs.writeFileSync(absoluteFilename, miseToml)
+
+    process.env.GITHUB_WORKSPACE = process.cwd()
+    const absoluteAppVersions = setupBeam.parseVersionFile(absoluteFilename)
+    assert.strictEqual(absoluteAppVersions.get('erlang'), erlang)
+    assert.strictEqual(absoluteAppVersions.get('elixir'), elixir)
+
+    assert.ok(async () => {
+      await setupBeam.install('otp', { toolVersion: erlang })
+    })
+    assert.ok(async () => {
+      await setupBeam.install('elixir', { toolVersion: elixir })
+    })
+    assert.ok(async () => {
+      await setupBeam.install('gleam', { toolVersion: gleam })
+    })
+  })
+
+  simulateInput('otp-version', otpVersion)
+  simulateInput('elixir-version', elixirVersion)
+  simulateInput('gleam-version', gleamVersion)
+})
+
 describe('.get(_)', () => {
   it('retries as expected', async () => {
     let attempt = 0