Support the manifest alias

Author: omus

.github/workflows/ci.yaml

@@ -43,17 +43,19 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
-      - name: Create Project.toml
+      - name: Create Project.toml and Manifest.toml
         shell: bash
         run: |
-          echo -e '[compat]\njulia = "1.6"' >Project.toml
+          echo -e '[compat]\njulia = "1.7"' >Project.toml
+          echo -e 'julia_version = "1.7.3"' >Manifest.toml
 
       - name: Test julia-version
         id: julia-version
         uses: ./
         with:
           versions: |
             - min
+            - manifest
             - lts
             - 1
             - ~1.10
@@ -63,10 +65,11 @@ jobs:
         shell: bash
         run: |
           set -x
-          [[ "$(jq -r 'length' <<<"$unique_json")" -eq 3 ]] || exit 1
-          [[ "$(jq -r '.[0]' <<<"$unique_json")" == "1.6.0" ]] || exit 1
-          [[ "$(jq -r '.[1]' <<<"$unique_json")" =~ ^1\.10\.([8-9]|[1-9][0-9]*)$ ]] || exit 1   # [1.10.8, 1.11.0)
-          [[ "$(jq -r '.[2]' <<<"$unique_json")" =~ ^1\.(1[1-9]|2[0-9]+)\.[0-9]+$ ]] || exit 1  # [1.11.0, ∞)
+          [[ "$(jq -r 'length' <<<"$unique_json")" -eq 4 ]] || exit 1
+          [[ "$(jq -r '.[0]' <<<"$unique_json")" == "1.7.0" ]] || exit 1
+          [[ "$(jq -r '.[1]' <<<"$unique_json")" == "1.7.3" ]] || exit 1
+          [[ "$(jq -r '.[2]' <<<"$unique_json")" =~ ^1\.10\.([8-9]|[1-9][0-9]*)$ ]] || exit 1   # [1.10.8, 1.11.0)
+          [[ "$(jq -r '.[3]' <<<"$unique_json")" =~ ^1\.(1[1-9]|2[0-9]+)\.[0-9]+$ ]] || exit 1  # [1.11.0, ∞)
 
           [[ "$version" == "" ]] || exit 1
         env:

README.md

@@ -167,6 +167,12 @@ Resolves to the lowest Julia version compatible with the Julia project. Using
 this alias requires that the `project` input refers to a directory containing a
 `Project.toml` (or `JuliaProject.toml`) and a `julia` compat entry exist.
 
+### `manifest` Alias
+
+Resolves to the Julia version as specified in the Julia manifest file. Using
+this alias requires that the `project` input refers to a directory containing a
+`Manifest.toml` (or `JuliaManifest.toml`).
+
 ### Grammar
 
 Here is the complete Backus-Naur grammar for a version specifier:
@@ -177,7 +183,7 @@ Here is the complete Backus-Naur grammar for a version specifier:
 <caret>     ::= "^" <partial>
 <partial>   ::= <n> | <n> "." <n> | <n> "." <n> "." <n>
 <nightly>   ::= <n> "." <n> "-nightly" | "nightly"
-<alias>     ::= "lts" | "min"
+<alias>     ::= "lts" | "min" | "manifest"
 <n>         ::= "0" | <positive> <digits>
 <digits>    ::= <digit> | <digit> <digits>
 <digit>     ::= "0" | <positive>

__fixtures__/constants.ts

@@ -10,6 +10,20 @@ export const versionsJsonFile = path.join(
   "versions.json"
 )
 
+export const projectDirV1 = path.join(
+  __dirname,
+  "..",
+  "__fixtures__",
+  "julia-manifest-v1"
+)
+
+export const projectDirV2 = path.join(
+  __dirname,
+  "..",
+  "__fixtures__",
+  "julia-manifest-v2"
+)
+
 export const testVersions = Object.keys(
   JSON.parse(fs.readFileSync(versionsJsonFile).toString())
 )

__fixtures__/julia-manifest-v1/Manifest.toml

@@ -0,0 +1,6 @@
+# This file is machine-generated - editing it directly is not advised
+
+[[Example]]
+git-tree-sha1 = "e1f0e1a832ccd8e97d6d0348dec33ee139a5aeaf"
+uuid = "7876af07-990d-54b4-ab0e-23690620f79a"
+version = "0.5.5"

__fixtures__/julia-manifest-v1/Project.toml

@@ -0,0 +1,6 @@
+[deps]
+Example = "7876af07-990d-54b4-ab0e-23690620f79a"
+
+[compat]
+Example = "0.5"
+julia = "~1.3, ~1.4, ~1.5, ~1.6"

__fixtures__/julia-manifest-v2/Manifest.toml

@@ -0,0 +1,10 @@
+# This file is machine-generated - editing it directly is not advised
+
+julia_version = "1.11.3"
+manifest_format = "2.0"
+project_hash = "2ca1c6c58cb30e79e021fb54e5626c96d05d5fdc"
+
+[[deps.Example]]
+git-tree-sha1 = "e1f0e1a832ccd8e97d6d0348dec33ee139a5aeaf"
+uuid = "7876af07-990d-54b4-ab0e-23690620f79a"
+version = "0.5.5"

__fixtures__/julia-manifest-v2/Project.toml

@@ -0,0 +1,6 @@
+[deps]
+Example = "7876af07-990d-54b4-ab0e-23690620f79a"
+
+[compat]
+Example = "0.5"
+julia = "1"

__tests__/input.test.ts

@@ -42,6 +42,7 @@ describe("parseVersionSpecifiers", () => {
   it("Handle alias scalar", () => {
     expect(parseVersionSpecifiers("lts")).toEqual(["lts"])
     expect(parseVersionSpecifiers("min")).toEqual(["min"])
+    expect(parseVersionSpecifiers("manifest")).toEqual(["manifest"])
 
     expect(() => parseVersionSpecifiers("pre")).toThrow(
       "Invalid version specifier"

__tests__/project.test.ts

@@ -10,6 +10,7 @@ import { tmpdir } from "node:os"
 import {
   getJuliaCompatRange,
   getJuliaProjectFile,
+  getJuliaManifestFile,
   validJuliaCompatRange,
 } from "../src/project.js"
 
@@ -26,10 +27,10 @@ describe("getJuliaProjectFile tests", () => {
 
   it("Can determine project file is missing", () => {
     expect(() => getJuliaProjectFile("DNE.toml")).toThrow(
-      "Unable to locate project file"
+      "Unable to locate Julia project file"
     )
     expect(() => getJuliaProjectFile(".")).toThrow(
-      "Unable to locate project file"
+      "Unable to locate Julia project file"
     )
   })
 
@@ -70,6 +71,60 @@ describe("getJuliaProjectFile tests", () => {
   })
 })
 
+describe("getJuliaManifestFile tests", () => {
+  let orgWorkingDir: string
+
+  beforeEach(() => {
+    orgWorkingDir = process.cwd()
+  })
+
+  afterEach(() => {
+    process.chdir(orgWorkingDir)
+  })
+
+  it("Can determine manifest file is missing", () => {
+    expect(() => getJuliaManifestFile(".")).toThrow(
+      "Unable to locate Julia manifest file"
+    )
+  })
+
+  it("Can determine project file from a directory", () => {
+    fs.mkdtemp(path.join(tmpdir(), "julia-version-"), (err, projectDir) => {
+      const manifestFile = path.join(projectDir, "Manifest.toml")
+      fs.closeSync(fs.openSync(manifestFile, "w"))
+      expect(getJuliaManifestFile(projectDir)).toEqual(manifestFile)
+    })
+
+    fs.mkdtemp(path.join(tmpdir(), "julia-version-"), (err, projectDir) => {
+      const manifestFile = path.join(projectDir, "JuliaManifest.toml")
+      fs.closeSync(fs.openSync(manifestFile, "w"))
+      expect(getJuliaManifestFile(projectDir)).toEqual(manifestFile)
+    })
+  })
+
+  it("Prefers using JuliaManifest.toml over Manifest.toml", () => {
+    fs.mkdtemp(path.join(tmpdir(), "julia-version-"), (err, projectDir) => {
+      const manifestFile = path.join(projectDir, "Manifest.toml")
+      fs.closeSync(fs.openSync(manifestFile, "w"))
+
+      const juliaManifestFile = path.join(projectDir, "JuliaManifest.toml")
+      fs.closeSync(fs.openSync(juliaManifestFile, "w"))
+
+      expect(getJuliaManifestFile(projectDir)).toEqual(juliaManifestFile)
+    })
+  })
+
+  it("Can determine project from the current working directory", () => {
+    fs.mkdtemp(path.join(tmpdir(), "julia-version-"), (err, projectDir) => {
+      const projectFile = path.join(projectDir, "Manifest.toml")
+      fs.closeSync(fs.openSync(projectFile, "w"))
+
+      process.chdir(projectDir)
+      expect(getJuliaManifestFile(".")).toEqual("Manifest.toml")
+    })
+  })
+})
+
 describe("validJuliaCompatRange tests", () => {
   it("Handles default caret specifier", () => {
     expect(validJuliaCompatRange("1")).toEqual(semver.validRange("^1"))

__tests__/version.test.ts

@@ -6,7 +6,12 @@ import nock from "nock"
 import semver from "semver"
 
 import * as core from "../__fixtures__/core.js"
-import { testVersions, versionsJsonFile } from "../__fixtures__/constants.js"
+import {
+  testVersions,
+  versionsJsonFile,
+  projectDirV1,
+  projectDirV2,
+} from "../__fixtures__/constants.js"
 
 // Mocks should be declared before the module being tested is imported.
 jest.unstable_mockModule("@actions/core", () => core)
@@ -67,6 +72,18 @@ describe("resolveVersions tests", () => {
     ])
   })
 
+  it("Handles alias: manifest", async () => {
+    await expect(resolveVersions(["manifest"], projectDirV2)).resolves.toEqual([
+      "1.11.3",
+    ])
+    await expect(resolveVersions(["manifest"], projectDirV1)).rejects.toThrow(
+      "No Julia version exists matching specifier"
+    )
+    await expect(resolveVersions(["manifest"], ".")).rejects.toThrow(
+      "Unable to locate Julia manifest file"
+    )
+  })
+
   it("Respects ifMissing error", async () => {
     await expect(
       resolveVersions(["1.9-nightly"], ".", { ifMissing: "error" })
@@ -124,6 +141,18 @@ describe("resolveVersion tests", () => {
     it("version alias: lts", () => {
       expect(resolveVersion("lts", testVersions)).toEqual(latestLts)
     })
+
+    it("version alias: manifest", () => {
+      expect(resolveVersion("manifest", testVersions)).toBeNull()
+      expect(resolveVersion("manifest", testVersions, null, "1.11.3")).toEqual(
+        "1.11.3"
+      )
+
+      // An unofficial build of say `1.12.0-DEV.850` is recorded as `1.12.0-DEV` in the manifest
+      expect(
+        resolveVersion("manifest", testVersions, null, "1.12.0-DEV")
+      ).toEqual("1.12.0-DEV")
+    })
   })
 
   describe("version ranges", () => {