Add --overwrite flag to tar extraction (#156)

* Add --overwrite flag to tar extraction

There are times when previous actions have already extracted at least
some files to the cache location. This results in subsequent cache
extraction operations to emit errors such as:

> /usr/bin/tar: [dest_file_path]: Cannot open: File exists

This adds the --overwrite flag to the extract call to force tar to
just overwrite these files rather than reporting errors.

Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>

* npm run lint-fix & npm run format

* ignore macOS

Co-authored-by: Sergey Vilgelm <sergey.vilgelm@ibm.com>

.eslintrc.json

@@ -1,7 +1,13 @@
 {
-  "env": { "node": true, "jest": true },
+  "env": {
+    "node": true,
+    "jest": true
+  },
   "parser": "@typescript-eslint/parser",
-  "parserOptions": { "ecmaVersion": 2020, "sourceType": "module" },
+  "parserOptions": {
+    "ecmaVersion": 2020,
+    "sourceType": "module"
+  },
   "extends": [
     "eslint:recommended",
     "plugin:@typescript-eslint/eslint-recommended",
@@ -9,15 +15,18 @@
     "plugin:import/errors",
     "plugin:import/warnings",
     "plugin:import/typescript",
-    "plugin:prettier/recommended",
+    "plugin:prettier/recommended"
-    "prettier/@typescript-eslint"
+  ],
+  "plugins": [
+    "@typescript-eslint",
+    "simple-import-sort"
   ],
-  "plugins": ["@typescript-eslint", "simple-import-sort"],
   "rules": {
     "import/first": "error",
     "import/newline-after-import": "error",
     "import/no-duplicates": "error",
-    "simple-import-sort/sort": "error",
+    "simple-import-sort/imports": "error",
+    "simple-import-sort/exports": "error",
     "sort-imports": "off"
   }
-}
+}

README.md

@@ -2,7 +2,7 @@
 
 [![Build Status](https://github.com/golangci/golangci-lint-action/workflows/build-and-test/badge.svg)](https://github.com/golangci/golangci-lint-action/actions)
 
-It's the official GitHub action for [golangci-lint](https://github.com/golangci/golangci-lint) from it's authors.
+It's the official GitHub action for [golangci-lint](https://github.com/golangci/golangci-lint) from its authors.
 The action runs [golangci-lint](https://github.com/golangci/golangci-lint) and reports issues from linters.
 
 ![GitHub Annotations](./static/annotations.png)
@@ -36,7 +36,7 @@ jobs:
       - name: golangci-lint
         uses: golangci/golangci-lint-action@v2
         with:
-          # Required: the version of golangci-lint is required and must be specified without patch version: we always use the latest patch version.
+          # Optional: version of golangci-lint to use in form of v1.2 or v1.2.3 or `latest` to use the latest version
           version: v1.29
 
           # Optional: working directory, useful for monorepos
@@ -47,6 +47,15 @@ jobs:
 
           # Optional: show only new issues if it's a pull request. The default value is `false`.
           # only-new-issues: true
+
+          # Optional: if set to true then the action will use pre-installed Go.
+          # skip-go-installation: true
+
+          # Optional: if set to true then the action don't cache or restore ~/go/pkg.
+          # skip-pkg-cache: true
+
+          # Optional: if set to true then the action don't cache or restore ~/.cache/go-build.
+          # skip-build-cache: true
 ```
 
 We recommend running this action in a job separate from other jobs (`go test`, etc)
@@ -94,7 +103,7 @@ jobs:
 You will also likely need to add the following `.gitattributes` file to ensure that line endings for windows builds are properly formatted:
 
 ```.gitattributes
-*.go text eol=lf 
+*.go text eol=lf
 ```
 
 ## Comments and Annotations

action.yml

@@ -1,4 +1,3 @@
----
 name: "Run golangci-lint"
 description: "Official golangci-lint action with line-attached annotations for found issues, caching and parallel execution."
 author: "golangci"
@@ -21,7 +20,18 @@ inputs:
     description: "if set to true and the action runs on a pull request - the action outputs only newly found issues"
     default: false
     required: true
-
+  skip-go-installation:
+    description: "if set to true then action uses pre-installed Go"
+    default: false
+    required: true
+  skip-pkg-cache:
+    description: "if set to true then the action don't cache or restore ~/go/pkg."
+    default: false
+    required: true
+  skip-build-cache:
+    description: "if set to true then the action don't cache or restore ~/.cache/go-build."
+    default: false
+    required: true
 runs:
   using: "node12"
   main: "dist/run/index.js"

package.json

@@ -26,28 +26,28 @@
   "author": "golangci",
   "license": "MIT",
   "dependencies": {
-    "@actions/cache": "^1.0.2",
+    "@actions/cache": "^1.0.6",
     "@actions/core": "^1.2.6",
     "@actions/exec": "^1.0.1",
     "@actions/github": "^4.0.0",
-    "@actions/tool-cache": "^1.6.0",
+    "@actions/tool-cache": "^1.6.1",
     "@types/semver": "^7.3.4",
     "@types/tmp": "^0.2.0",
     "setup-go": "git+https://github.com/actions/setup-go.git#v2.1.3",
     "tmp": "^0.2.1"
   },
   "devDependencies": {
-    "@types/node": "^14.11.10",
+    "@types/node": "^14.14.31",
     "@types/uuid": "^8.3.0",
-    "@typescript-eslint/eslint-plugin": "^2.34.0",
+    "@typescript-eslint/eslint-plugin": "^4.15.1",
-    "@typescript-eslint/parser": "^2.34.0",
+    "@typescript-eslint/parser": "^4.15.1",
     "@zeit/ncc": "^0.22.3",
-    "eslint": "^6.6.0",
+    "eslint": "^7.20.0",
-    "eslint-config-prettier": "^6.13.0",
+    "eslint-config-prettier": "^8.0.0",
     "eslint-plugin-import": "^2.22.1",
-    "eslint-plugin-prettier": "^3.1.4",
+    "eslint-plugin-prettier": "^3.3.1",
-    "eslint-plugin-simple-import-sort": "^5.0.2",
+    "eslint-plugin-simple-import-sort": "^7.0.0",
-    "prettier": "^2.1.2",
+    "prettier": "^2.2.1",
-    "typescript": "^4.0.3"
+    "typescript": "^4.1.5"
   }
 }

src/cache.ts

@@ -25,7 +25,22 @@ const getLintCacheDir = (): string => {
 
 const getCacheDirs = (): string[] => {
   // Not existing dirs are ok here: it works.
-  return [getLintCacheDir(), path.resolve(`${process.env.HOME}/.cache/go-build`), path.resolve(`${process.env.HOME}/go/pkg`)]
+  const skipPkgCache = core.getInput(`skip-pkg-cache`, { required: true }).trim()
+  const skipBuildCache = core.getInput(`skip-build-cache`, { required: true }).trim()
+  const dirs = [getLintCacheDir()]
+
+  if (skipBuildCache.toLowerCase() == "true") {
+    core.info(`Omitting ~/.cache/go-build from cache directories`)
+  } else {
+    dirs.push(path.resolve(`${process.env.HOME}/.cache/go-build`))
+  }
+  if (skipPkgCache.toLowerCase() == "true") {
+    core.info(`Omitting ~/go/pkg from cache directories`)
+  } else {
+    dirs.push(path.resolve(`${process.env.HOME}/go/pkg`))
+  }
+
+  return dirs
 }
 
 const getIntervalKey = (invalidationIntervalDays: number): string => {

src/install.ts

@@ -45,7 +45,12 @@ export async function installLint(versionConfig: VersionConfig): Promise<string>
     extractedDir = await tc.extractZip(archivePath, process.env.HOME)
     repl = /\.zip$/
   } else {
-    extractedDir = await tc.extractTar(archivePath, process.env.HOME)
+    // We want to always overwrite files if the local cache already has them
+    const args = ["xz"]
+    if (process.platform.toString() != "darwin") {
+      args.push("--overwrite")
+    }
+    extractedDir = await tc.extractTar(archivePath, process.env.HOME, args)
   }
 
   const urlParts = assetURL.split(`/`)
@@ -56,6 +61,12 @@ export async function installLint(versionConfig: VersionConfig): Promise<string>
 }
 
 export async function installGo(): Promise<void> {
+  const skipGoInstallation = core.getInput(`skip-go-installation`, { required: true }).trim()
+  if (skipGoInstallation.toLowerCase() == "true") {
+    core.info(`Skipping the installation of Go`)
+    return
+  }
+
   const startedAt = Date.now()
   process.env[`INPUT_GO-VERSION`] = `1`
   await setupGo()

src/run.ts

@@ -187,6 +187,7 @@ async function runLint(lintPath: string, patchPath: string): Promise<void> {
 export async function run(): Promise<void> {
   try {
     const { lintPath, patchPath } = await core.group(`prepare environment`, prepareEnv)
+    core.addPath(path.dirname(lintPath))
     await core.group(`run golangci-lint`, () => runLint(lintPath, patchPath))
   } catch (error) {
     core.error(`Failed to run: ${error}, ${error.stack}`)