feat: add version-file option (#1320)

README.md

@@ -261,21 +261,22 @@ You will also likely need to add the following `.gitattributes` file to ensure t
 
 ### Overview
 
-| Option                                                        | Description                                        |
+| Option                                                        | Description                                           |
-|---------------------------------------------------------------|----------------------------------------------------|
+|---------------------------------------------------------------|-------------------------------------------------------|
-| [`version`](#version)                                         | The version of golangci-lint to use.               |
+| [`version`](#version)                                         | The version of golangci-lint to use.                  |
-| [`install-mode`](#install-mode)                               | The mode to install golangci-lint.                 |
+| [`version-file`](#version-file)                               | Gets the version of golangci-lint to use from a file. |
-| [`install-only`](#install-only)                               | Only install golangci-lint.                        |
+| [`install-mode`](#install-mode)                               | The mode to install golangci-lint.                    |
-| [`verify`](#verify)                                           | Validates golangci-lint configuration file.        |
+| [`install-only`](#install-only)                               | Only install golangci-lint.                           |
-| [`github-token`](#github-token)                               | Used by the `only-new-issues` option.              |
+| [`verify`](#verify)                                           | Validates golangci-lint configuration file.           |
-| [`only-new-issues`](#only-new-issues)                         | Show only new issues.                              |
+| [`github-token`](#github-token)                               | Used by the `only-new-issues` option.                 |
-| [`working-directory`](#working-directory)                     | The golangci-lint working directory.               |
+| [`only-new-issues`](#only-new-issues)                         | Show only new issues.                                 |
-| [`args`](#args)                                               | Golangci-lint command line arguments.              |
+| [`working-directory`](#working-directory)                     | The golangci-lint working directory.                  |
-| [`skip-cache`](#skip-cache)                                   | Disable cache support.                             |
+| [`args`](#args)                                               | Golangci-lint command line arguments.                 |
-| [`skip-save-cache`](#skip-save-cache)                         | Don't save cache.                                  |
+| [`skip-cache`](#skip-cache)                                   | Disable cache support.                                |
-| [`cache-invalidation-interval`](#cache-invalidation-interval) | Number of days before cache invalidation.          |
+| [`skip-save-cache`](#skip-save-cache)                         | Don't save cache.                                     |
-| [`problem-matchers`](#problem-matchers)                       | Forces the usage of the embedded problem matchers. |
+| [`cache-invalidation-interval`](#cache-invalidation-interval) | Number of days before cache invalidation.             |
-| [Experimental](#experimental)                                 | Experimental options                               |
+| [`problem-matchers`](#problem-matchers)                       | Forces the usage of the embedded problem matchers.    |
+| [Experimental](#experimental)                                 | Experimental options                                  |
 
 ### Installation
 
@@ -302,6 +303,28 @@ with:
 
 </details>
 
+#### `version-file`
+
+Gets the version of golangci-lint to use from a file.
+
+The path must be relative to the root of the project, or the `working-directory` if defined.
+
+This parameter supports `.golangci-lint-version`, and `.tool-versions` files.
+
+Only works with `install-mode: binary` (the default).
+
+<details>
+<summary>Example</summary>
+
+```yml
+uses: golangci/golangci-lint-action@v9
+with:
+  version-file: .tool-versions
+  # ...
+```
+
+</details>
+
 #### `install-mode`
 
 (optional)

action.yml

@@ -11,6 +11,13 @@ inputs:
       - `goinstall`: the value can be v2.3.4, `latest`, or the hash of a commit.
       - `none`: the value is ignored.
     required: false
+  version-file:
+    description: |
+      Gets the version of golangci-lint to use from a file.
+      The path must be relative to the root of the project, or the `working-directory` if defined.
+      This parameter supports `.golangci-lint-version`, and `.tool-versions` files.
+      Only works with `install-mode: binary` (the default).
+    required: false
   install-mode:
     description: "The mode to install golangci-lint. It can be 'binary', 'goinstall', or 'none'."
     default: "binary"

dist/post_run/index.js

@@ -97912,6 +97912,10 @@ const isLessVersion = (a, b) => {
 };
 const getRequestedVersion = () => {
     let requestedVersion = core.getInput(`version`);
+    let versionFilePath = core.getInput(`version-file`);
+    if (requestedVersion && versionFilePath) {
+        core.warning(`Both version (${requestedVersion}) and version-file (${versionFilePath}) inputs are specified, only version will be used`);
+    }
     const workingDirectory = core.getInput(`working-directory`);
     let goMod = "go.mod";
     if (workingDirectory) {
@@ -97925,6 +97929,24 @@ const getRequestedVersion = () => {
             core.info(`Found golangci-lint version '${requestedVersion}' in '${goMod}' file`);
         }
     }
+    if (requestedVersion == "" && versionFilePath) {
+        if (workingDirectory) {
+            versionFilePath = path_1.default.join(workingDirectory, versionFilePath);
+        }
+        if (!fs.existsSync(versionFilePath)) {
+            throw new Error(`The specified golangci-lint version file at: ${versionFilePath} does not exist`);
+        }
+        const content = fs.readFileSync(versionFilePath, "utf-8");
+        if (path_1.default.basename(versionFilePath) === ".tool-versions") {
+            // asdf/mise file.
+            const match = content.match(/^golangci-lint\s+([^\n#]+)/m);
+            requestedVersion = match ? "v" + match[1].trim().replace(/^v/gi, "") : "";
+        }
+        else {
+            // .golangci-lint-version file.
+            requestedVersion = "v" + content.trim().replace(/^v/gi, "");
+        }
+    }
     const parsedRequestedVersion = parseVersion(requestedVersion);
     if (parsedRequestedVersion == null) {
         return null;

dist/run/index.js

@@ -97912,6 +97912,10 @@ const isLessVersion = (a, b) => {
 };
 const getRequestedVersion = () => {
     let requestedVersion = core.getInput(`version`);
+    let versionFilePath = core.getInput(`version-file`);
+    if (requestedVersion && versionFilePath) {
+        core.warning(`Both version (${requestedVersion}) and version-file (${versionFilePath}) inputs are specified, only version will be used`);
+    }
     const workingDirectory = core.getInput(`working-directory`);
     let goMod = "go.mod";
     if (workingDirectory) {
@@ -97925,6 +97929,24 @@ const getRequestedVersion = () => {
             core.info(`Found golangci-lint version '${requestedVersion}' in '${goMod}' file`);
         }
     }
+    if (requestedVersion == "" && versionFilePath) {
+        if (workingDirectory) {
+            versionFilePath = path_1.default.join(workingDirectory, versionFilePath);
+        }
+        if (!fs.existsSync(versionFilePath)) {
+            throw new Error(`The specified golangci-lint version file at: ${versionFilePath} does not exist`);
+        }
+        const content = fs.readFileSync(versionFilePath, "utf-8");
+        if (path_1.default.basename(versionFilePath) === ".tool-versions") {
+            // asdf/mise file.
+            const match = content.match(/^golangci-lint\s+([^\n#]+)/m);
+            requestedVersion = match ? "v" + match[1].trim().replace(/^v/gi, "") : "";
+        }
+        else {
+            // .golangci-lint-version file.
+            requestedVersion = "v" + content.trim().replace(/^v/gi, "");
+        }
+    }
     const parsedRequestedVersion = parseVersion(requestedVersion);
     if (parsedRequestedVersion == null) {
         return null;

src/version.ts

@@ -67,6 +67,12 @@ const isLessVersion = (a: Version, b: Version): boolean => {
 
 const getRequestedVersion = (): Version => {
   let requestedVersion = core.getInput(`version`)
+  let versionFilePath = core.getInput(`version-file`)
+
+  if (requestedVersion && versionFilePath) {
+    core.warning(`Both version (${requestedVersion}) and version-file (${versionFilePath}) inputs are specified, only version will be used`)
+  }
+
   const workingDirectory = core.getInput(`working-directory`)
 
   let goMod = "go.mod"
@@ -83,6 +89,27 @@ const getRequestedVersion = (): Version => {
     }
   }
 
+  if (requestedVersion == "" && versionFilePath) {
+    if (workingDirectory) {
+      versionFilePath = path.join(workingDirectory, versionFilePath)
+    }
+
+    if (!fs.existsSync(versionFilePath)) {
+      throw new Error(`The specified golangci-lint version file at: ${versionFilePath} does not exist`)
+    }
+
+    const content = fs.readFileSync(versionFilePath, "utf-8")
+
+    if (path.basename(versionFilePath) === ".tool-versions") {
+      // asdf/mise file.
+      const match = content.match(/^golangci-lint\s+([^\n#]+)/m)
+      requestedVersion = match ? "v" + match[1].trim().replace(/^v/gi, "") : ""
+    } else {
+      // .golangci-lint-version file.
+      requestedVersion = "v" + content.trim().replace(/^v/gi, "")
+    }
+  }
+
   const parsedRequestedVersion = parseVersion(requestedVersion)
   if (parsedRequestedVersion == null) {
     return null