Run action on different platforms (#65)

* build(deps): bump @actions/github from 2.1.1 to 4.0.0

Bumps [@actions/github](https://github.com/actions/toolkit/tree/HEAD/packages/github) from 2.1.1 to 4.0.0.
- [Release notes](https://github.com/actions/toolkit/releases)
- [Changelog](https://github.com/actions/toolkit/blob/master/packages/github/RELEASES.md)
- [Commits](https://github.com/actions/toolkit/commits/HEAD/packages/github)

Signed-off-by: dependabot[bot] <support@github.com>

* Fix usage of github action

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Sergey Vilgelm <sergey.vilgelm@ibm.com>

.github/dependabot.yml

@@ -0,0 +1,14 @@
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: "/"
+    schedule:
+      interval: weekly
+    reviewers:
+      - "golangci/team"
+  - package-ecosystem: npm
+    directory: "/"
+    schedule:
+      interval: weekly
+    reviewers:
+      - "golangci/team"

.github/workflows/test.yml

@@ -4,7 +4,7 @@ on: # rebuild any PRs and main branch changes
   push:
     branches:
       - master
-      - 'releases/*'
+      - "releases/*"
 
 jobs:
   build: # make sure build/ci work properly
@@ -13,14 +13,19 @@ jobs:
       - uses: actions/checkout@v2
       - run: |
           npm install
-        npm run prepare-deps
           npm run all
   test: # make sure the action works on a clean machine without building
-    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        os:
+          - ubuntu-latest
+          - macos-latest
+          - windows-latest
+    runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v2
       - uses: ./
         with:
-        version: v1.28
+          version: latest
           args: --issues-exit-code=0 ./sample/...
           only-new-issues: true

README.md

@@ -7,6 +7,12 @@ The action runs [golangci-lint](https://github.com/golangci/golangci-lint) and r
 
 ![GitHub Annotations](./static/annotations.png)
 
+## Compatibility
+
+* `v2.0.0+` works with `golangci-lint` version >= `v1.28.3`
+* `v1.2.2` is deprecated due to we forgot to change the minimum version of `golangci-lint` to `v1.28.3` ([issue](https://github.com/golangci/golangci-lint-action/issues/39))
+* `v1.2.1` works with `golangci-lint` version >= `v1.14.0` ([issue](https://github.com/golangci/golangci-lint-action/issues/39))
+
 ## How to use
 
 Add `.github/workflows/golangci-lint.yml` with the following contents:
@@ -30,7 +36,7 @@ jobs:
         uses: golangci/golangci-lint-action@v1
         with:
           # Required: the version of golangci-lint is required and must be specified without patch version: we always use the latest patch version.
-          version: v1.26
+          version: v1.29
 
           # Optional: working directory, useful for monorepos
           # working-directory: somedir
@@ -76,6 +82,8 @@ We use JavaScript-based action. We don't use Docker-based action because:
 1. docker pulling is slow currently
 2. it's easier to use caching from [@actions/cache](https://github.com/actions/toolkit/tree/master/packages/cache)
 
+We support different platforms, such as `ubuntu`, `macos` and `windows` with `x32` and `x64` archs.
+
 Inside our action we perform 3 steps:
 
 1. Setup environment running in parallel:
@@ -89,7 +97,7 @@ Inside our action we perform 3 steps:
 ### Caching internals
 
 1. We save and restore the following directories: `~/.cache/golangci-lint`, `~/.cache/go-build`, `~/go/pkg`.
-2. The primary caching key looks like `golangci-lint.cache-{interval_number}-{go.mod_hash}`. Interval number ensures that we periodically invalidate
+2. The primary caching key looks like `golangci-lint.cache-{platform-arch}-{interval_number}-{go.mod_hash}`. Interval number ensures that we periodically invalidate
    our cache (every 7 days). `go.mod` hash ensures that we invalidate the cache early - as soon as dependencies have changed.
 3. We use [restore keys](https://help.github.com/en/actions/configuring-and-managing-workflows/caching-dependencies-to-speed-up-workflows#matching-a-cache-key): `golangci-lint.cache-{interval_number}-`, `golangci-lint.cache-`. GitHub matches keys by prefix if we have no exact match for the primary cache.
 

action.yml

@@ -1,31 +1,31 @@
 ---
-name: 'Run golangci-lint'
-description: 'Official golangci-lint action with line-attached annotations for found issues, caching and parallel execution.'
-author: 'golangci'
+name: "Run golangci-lint"
+description: "Official golangci-lint action with line-attached annotations for found issues, caching and parallel execution."
+author: "golangci"
 inputs:
   version:
-    description: 'version of golangci-lint to use in form of v1.2'
-    required: true
+    description: "version of golangci-lint to use in form of v1.2 or `latest` to use the latest version"
+    required: false
   args:
-    description: 'golangci-lint command line arguments'
-    default: ''
+    description: "golangci-lint command line arguments"
+    default: ""
     required: false
   working-directory:
-    description: 'golangci-lint working directory, default is project root'
+    description: "golangci-lint working directory, default is project root"
     required: false
   github-token:
-    description: 'the token is used for fetching patch of a pull request to show only new issues'
+    description: "the token is used for fetching patch of a pull request to show only new issues"
     default: ${{ github.token }}
     required: true
   only-new-issues:
-    description: 'if set to true and the action runs on a pull request - the action outputs only newly found issues'
+    description: "if set to true and the action runs on a pull request - the action outputs only newly found issues"
     default: false
     required: true
 
 runs:
-  using: 'node12'
-  main: 'dist/run/index.js'
-  post: 'dist/post_run/index.js'
+  using: "node12"
+  main: "dist/run/index.js"
+  post: "dist/post_run/index.js"
 branding:
-  icon: 'shield'
-  color: 'yellow'
+  icon: "shield"
+  color: "yellow"

package.json

@@ -1,6 +1,6 @@
 {
   "name": "golanci-lint-action",
-  "version": "1.1.2",
+  "version": "2.0.0",
   "private": true,
   "description": "golangci-lint github action",
   "main": "dist/main.js",
@@ -15,38 +15,38 @@
     "lint-fix": "eslint **/*.ts --cache --fix",
     "format": "prettier --write **/*.ts",
     "format-check": "prettier --check **/*.ts",
-    "all": "npm run build && npm run format-check && npm run lint",
+    "all": "npm run prepare-deps && npm run build && npm run format-check && npm run lint",
     "local": "npm run build && act -j test -b"
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/golangci/golangci-lint-action.git"
   },
-  "author": "GitHub",
+  "author": "golangci",
   "license": "MIT",
   "dependencies": {
+    "@actions/cache": "^1.0.1",
     "@actions/core": "^1.2.0",
     "@actions/exec": "^1.0.1",
-    "@actions/github": "^2.1.1",
-    "@actions/tool-cache": "^1.3.4",
-    "@actions/cache": "^0.2.1",
-    "@types/semver": "^7.1.0",
+    "@actions/github": "^4.0.0",
+    "@actions/tool-cache": "^1.6.0",
+    "@types/semver": "^7.3.1",
     "@types/tmp": "^0.2.0",
-    "setup-go": "git+https://github.com/actions/setup-go.git#v2.1.0",
+    "setup-go": "git+https://github.com/actions/setup-go.git#v2.1.1",
     "tmp": "^0.2.1"
   },
   "devDependencies": {
-    "@types/node": "^12.0.4",
-    "@types/uuid": "^3.4.5",
-    "@typescript-eslint/eslint-plugin": "^2.7.0",
-    "@typescript-eslint/parser": "^2.7.0",
-    "@zeit/ncc": "^0.20.5",
+    "@types/node": "^14.0.27",
+    "@types/uuid": "^8.0.0",
+    "@typescript-eslint/eslint-plugin": "^2.34.0",
+    "@typescript-eslint/parser": "^2.34.0",
+    "@zeit/ncc": "^0.22.3",
     "eslint": "^6.6.0",
     "eslint-config-prettier": "^6.5.0",
-    "eslint-plugin-import": "^2.18.2",
-    "eslint-plugin-prettier": "^3.1.1",
+    "eslint-plugin-import": "^2.22.0",
+    "eslint-plugin-prettier": "^3.1.4",
     "eslint-plugin-simple-import-sort": "^5.0.2",
-    "prettier": "^1.19.1",
-    "typescript": "^3.8.3"
+    "prettier": "^2.0.5",
+    "typescript": "^3.9.7"
   }
 }

src/cache.ts

@@ -2,6 +2,7 @@ import * as cache from "@actions/cache"
 import * as core from "@actions/core"
 import * as crypto from "crypto"
 import * as fs from "fs"
+import path from "path"
 
 import { Events, State } from "./constants"
 import * as utils from "./utils/actionUtils"
@@ -10,19 +11,21 @@ function checksumFile(hashName: string, path: string): Promise<string> {
   return new Promise((resolve, reject) => {
     const hash = crypto.createHash(hashName)
     const stream = fs.createReadStream(path)
-    stream.on("error", err => reject(err))
-    stream.on("data", chunk => hash.update(chunk))
+    stream.on("error", (err) => reject(err))
+    stream.on("data", (chunk) => hash.update(chunk))
     stream.on("end", () => resolve(hash.digest("hex")))
   })
 }
 
 const pathExists = async (path: string): Promise<boolean> => !!(await fs.promises.stat(path).catch(() => false))
 
-const getLintCacheDir = (): string => `${process.env.HOME}/.cache/golangci-lint`
+const getLintCacheDir = (): string => {
+  return path.resolve(`${process.env.HOME}/.cache/golangci-lint`)
+}
 
 const getCacheDirs = (): string[] => {
   // Not existing dirs are ok here: it works.
-  return [getLintCacheDir(), `${process.env.HOME}/.cache/go-build`, `${process.env.HOME}/go/pkg`]
+  return [getLintCacheDir(), path.resolve(`${process.env.HOME}/.cache/go-build`), path.resolve(`${process.env.HOME}/go/pkg`)]
 }
 
 const getIntervalKey = (invalidationIntervalDays: number): string => {

src/install.ts

@@ -1,21 +1,55 @@
 import * as core from "@actions/core"
 import * as tc from "@actions/tool-cache"
+import os from "os"
 import path from "path"
 import { run as setupGo } from "setup-go/lib/main"
 
 import { VersionConfig } from "./version"
 
+const downloadURL = "https://github.com/golangci/golangci-lint/releases/download"
+
+const getAssetURL = (versionConfig: VersionConfig): string => {
+  let ext = "tar.gz"
+  let platform = os.platform().toString()
+  switch (platform) {
+    case "win32":
+      platform = "windows"
+      ext = "zip"
+      break
+  }
+  let arch = os.arch()
+  switch (arch) {
+    case "x64":
+      arch = "amd64"
+      break
+    case "x32":
+    case "ia32":
+      arch = "386"
+      break
+  }
+  const noPrefix = versionConfig.TargetVersion.slice(1)
+
+  return `${downloadURL}/${versionConfig.TargetVersion}/golangci-lint-${noPrefix}-${platform}-${arch}.${ext}`
+}
+
 // The installLint returns path to installed binary of golangci-lint.
 export async function installLint(versionConfig: VersionConfig): Promise<string> {
   core.info(`Installing golangci-lint ${versionConfig.TargetVersion}...`)
   const startedAt = Date.now()
+  const assetURL = getAssetURL(versionConfig)
+  core.info(`Downloading ${assetURL} ...`)
+  const archivePath = await tc.downloadTool(assetURL)
+  let extractedDir = ""
+  let repl = /\.tar\.gz$/
+  if (assetURL.endsWith("zip")) {
+    extractedDir = await tc.extractZip(archivePath, process.env.HOME)
+    repl = /\.zip$/
+  } else {
+    extractedDir = await tc.extractTar(archivePath, process.env.HOME)
+  }
 
-  core.info(`Downloading ${versionConfig.AssetURL} ...`)
-  const tarGzPath = await tc.downloadTool(versionConfig.AssetURL)
-  const extractedDir = await tc.extractTar(tarGzPath, process.env.HOME)
-
-  const urlParts = versionConfig.AssetURL.split(`/`)
-  const dirName = urlParts[urlParts.length - 1].replace(/\.tar\.gz$/, ``)
+  const urlParts = assetURL.split(`/`)
+  const dirName = urlParts[urlParts.length - 1].replace(repl, ``)
   const lintPath = path.join(extractedDir, dirName, `golangci-lint`)
   core.info(`Installed golangci-lint into ${lintPath} in ${Date.now() - startedAt}ms`)
   return lintPath

src/run.ts

@@ -39,7 +39,7 @@ async function fetchPatch(): Promise<string> {
     return ``
   }
 
-  const octokit = new github.GitHub(core.getInput(`github-token`, { required: true }))
+  const octokit = github.getOctokit(core.getInput(`github-token`, { required: true }))
   let patch: string
   try {
     const patchResp = await octokit.pulls.get({
@@ -125,9 +125,9 @@ async function runLint(lintPath: string, patchPath: string): Promise<void> {
   const userArgNames = new Set<string>()
   userArgs
     .split(/\s/)
-    .map(arg => arg.split(`=`)[0])
-    .filter(arg => arg.startsWith(`-`))
-    .forEach(arg => {
+    .map((arg) => arg.split(`=`)[0])
+    .filter((arg) => arg.startsWith(`-`))
+    .forEach((arg) => {
       userArgNames.add(arg.replace(`-`, ``))
     })
 

src/version.ts

@@ -6,11 +6,14 @@ export type Version = {
   major: number
   minor: number
   patch: number | null
-}
+} | null
 
 const versionRe = /^v(\d+)\.(\d+)(?:\.(\d+))?$/
 
 const parseVersion = (s: string): Version => {
+  if (s == "latest" || s == "") {
+    return null
+  }
   const match = s.match(versionRe)
   if (!match) {
     throw new Error(`invalid version string '${s}', expected format v1.2 or v1.2.3`)
@@ -23,33 +26,41 @@ const parseVersion = (s: string): Version => {
   }
 }
 
-export const stringifyVersion = (v: Version): string => `v${v.major}.${v.minor}${v.patch !== null ? `.${v.patch}` : ``}`
+export const stringifyVersion = (v: Version): string => {
+  if (v == null) {
+    return "latest"
+  }
+  return `v${v.major}.${v.minor}${v.patch !== null ? `.${v.patch}` : ``}`
+}
 
 const minVersion = {
   major: 1,
-  minor: 14,
-  patch: 0,
+  minor: 28,
+  patch: 3,
 }
 
 const isLessVersion = (a: Version, b: Version): boolean => {
+  if (a == null) {
+    return true
+  }
+  if (b == null) {
+    return false
+  }
   if (a.major != b.major) {
     return a.major < b.major
   }
 
-  if (a.minor != b.minor) {
+  // Do not compare patch parts because if the min version has a non zero value
+  // then it returns false, since the patch version of requested is always zero
   return a.minor < b.minor
 }
 
-  if (a.patch === null || b.patch === null) {
-    return true
-  }
-
-  return a.patch < b.patch
-}
-
 const getRequestedLintVersion = (): Version => {
-  const requestedLintVersion = core.getInput(`version`, { required: true })
+  const requestedLintVersion = core.getInput(`version`)
   const parsedRequestedLintVersion = parseVersion(requestedLintVersion)
+  if (parsedRequestedLintVersion == null) {
+    return null
+  }
   if (parsedRequestedLintVersion.patch !== null) {
     throw new Error(
       `requested golangci-lint version '${requestedLintVersion}' was specified with the patch version, need specify only minor version`
@@ -99,15 +110,14 @@ const getConfig = async (): Promise<Config> => {
 export async function findLintVersion(): Promise<VersionConfig> {
   core.info(`Finding needed golangci-lint version...`)
   const startedAt = Date.now()
-  const reqLintVersion = getRequestedLintVersion()
 
   const config = await getConfig()
-
   if (!config.MinorVersionToConfig) {
     core.warning(JSON.stringify(config))
     throw new Error(`invalid config: no MinorVersionToConfig field`)
   }
 
+  const reqLintVersion = getRequestedLintVersion()
   const versionConfig = config.MinorVersionToConfig[stringifyVersion(reqLintVersion)]
   if (!versionConfig) {
     throw new Error(`requested golangci-lint version '${stringifyVersion(reqLintVersion)}' doesn't exist`)
@@ -118,8 +128,9 @@ export async function findLintVersion(): Promise<VersionConfig> {
   }
 
   core.info(
-    `Requested golangci-lint '${stringifyVersion(reqLintVersion)}', using '${versionConfig.TargetVersion}', calculation took ${Date.now() -
-      startedAt}ms`
+    `Requested golangci-lint '${stringifyVersion(reqLintVersion)}', using '${versionConfig.TargetVersion}', calculation took ${
+      Date.now() - startedAt
+    }ms`
   )
   return versionConfig
 }