Expire cache periodically to avoid unbounded size (#466)

* Expire cache periodically to avoid unbounded size

The cache key includes a sequence number that rotates every 7 days
but because we are also using the base `golangci-lint.cache` as a
restore key, the new cache will always be seeded with the full
contents of the old cache.

In particular for the go module cache, this leads to an ever
increasing number of cached packages that never get pruned.

This commit updates it so we stop using `golangci-lint.cache` as
a restore key, which will force a build from an empty cache once
every 7 days.

* Rebuild files in dist/

.github/workflows/codeql.yaml

@@ -16,7 +16,7 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           # Must fetch at least the immediate parents so that if this is
           # a pull request then we can checkout the head of the pull request.
@@ -31,7 +31,7 @@ jobs:
 
       # Initializes the CodeQL tools for scanning.
       - name: Initialize CodeQL
-        uses: github/codeql-action/init@v1
+        uses: github/codeql-action/init@v2
         # Override language selection by uncommenting this and choosing your languages
         with:
           language: 'javascript'
@@ -41,4 +41,4 @@ jobs:
           npm run all
 
       - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@v1
+        uses: github/codeql-action/analyze@v2

.github/workflows/test.yml

@@ -10,12 +10,32 @@ jobs:
   build: # make sure build/ci work properly
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - run: |
           npm install
           npm run all
 
+      # Update dist files if there is label dependencies
+      - name: Update dist files
+        if: github.event_name == 'pull_request' && contains(github.event.pull_request.labels.*.name, 'dependencies')
+        run: |
+          if [[ -z $(git status -s) ]]
+          then
+            echo "No change is required"
+          else
+            echo "Updating dist directory"
+            git config --local user.name "dependabot[bot]"
+            git config --local user.email "49699333+dependabot[bot]@users.noreply.github.com"
+            git add --update
+            git commit --message="Update dist files"
+            git push
+          fi
+
+      # Fail the build if there is dirty change
+      - run: git diff --exit-code
+
   test: # make sure the action works on a clean machine without building
+    needs: [ build ]
     strategy:
       matrix:
         os:
@@ -28,15 +48,20 @@ jobs:
           - "v1.37"
           - "v1.37.1"
     runs-on: ${{ matrix.os }}
+    permissions:
+      contents: read
+      pull-requests: read
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
+      - uses: actions/setup-go@v3
       - uses: ./
         with:
           version: ${{ matrix.version }}
-          args: --issues-exit-code=0 ./sample/...
+          args: --timeout=3m --issues-exit-code=0 ./sample/...
           only-new-issues: true
 
   test-go-mod-version:
+    needs: [ build ]
     strategy:
       matrix:
         os:
@@ -44,9 +69,12 @@ jobs:
           - macos-latest
           - windows-latest
     runs-on: ${{ matrix.os }}
+    permissions:
+      contents: read
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
+      - uses: actions/setup-go@v3
       - uses: ./
         with:
           working-directory: sample-go-mod
-          args: --issues-exit-code=0 ./...
+          args: --timeout=3m --issues-exit-code=0 ./...

.nvmrc

@@ -0,0 +1 @@
+v16

README.md

@@ -9,6 +9,8 @@ The action runs [golangci-lint](https://github.com/golangci/golangci-lint) and r
 
 ## Compatibility
 
+* `v3.0.0+` requires explicit setup-go installation step prior to using this action: `uses: actions/setup-go@v3`.
+  The `skip-go-installation` option has been removed.
 * `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))
@@ -27,14 +29,21 @@ on:
       - master
       - main
   pull_request:
+permissions:
+  contents: read
+  # Optional: allow read access to pull request. Use with `only-new-issues` option.
+  # pull-requests: read
 jobs:
   golangci:
     name: lint
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/setup-go@v3
+        with:
+          go-version: 1.17
+      - uses: actions/checkout@v3
       - name: golangci-lint
-        uses: golangci/golangci-lint-action@v2
+        uses: golangci/golangci-lint-action@v3
         with:
           # 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
@@ -48,8 +57,9 @@ 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 all caching functionality will be complete disabled,
+          #           takes precedence over all other caching options.
+          # skip-cache: true
 
           # Optional: if set to true then the action don't cache or restore ~/go/pkg.
           # skip-pkg-cache: true
@@ -75,18 +85,25 @@ on:
       - master
       - main
   pull_request:
+permissions:
+  contents: read
+  # Optional: allow read access to pull request. Use with `only-new-issues` option.
+  # pull-requests: read
 jobs:
   golangci:
     strategy:
       matrix:
-        go-version: [1.15.x]
+        go: [1.17]
         os: [macos-latest, windows-latest]
     name: lint
     runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/setup-go@v3
+        with:
+          go-version: ${{ matrix.go }}
+      - uses: actions/checkout@v3
       - name: golangci-lint
-        uses: golangci/golangci-lint-action@v2
+        uses: golangci/golangci-lint-action@v3
         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.29
@@ -125,7 +142,6 @@ The action was implemented with performance in mind:
 
 For example, in a repository of [golangci-lint](https://github.com/golangci/golangci-lint) running this action without the cache takes 50s, but with cache takes 14s:
   * in parallel:
-    * 13s to download Go
     * 4s to restore 50 MB of cache
     * 1s to find and install `golangci-lint`
   * 1s to run `golangci-lint` (it takes 35s without cache)
@@ -145,7 +161,6 @@ Inside our action we perform 3 steps:
   * restore [cache](https://github.com/actions/cache) of previous analyzes
   * fetch [action config](https://github.com/golangci/golangci-lint/blob/master/assets/github-action-config.json) and find the latest `golangci-lint` patch version
     for needed version (users of this action can specify only minor version of `golangci-lint`). After that install [golangci-lint](https://github.com/golangci/golangci-lint) using [@actions/tool-cache](https://github.com/actions/toolkit/tree/master/packages/tool-cache)
-  * install the latest Go 1.x version using [@actions/setup-go](https://github.com/actions/setup-go)
 2. Run `golangci-lint` with specified by user `args`
 3. Save cache for later builds
 

action.yml

@@ -20,20 +20,22 @@ 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"
+  skip-cache:
+    description: |
+      if set to true then the all caching functionality will be complete disabled,
+      takes precedence over all other caching options.
     default: false
     required: true
   skip-pkg-cache:
-    description: "if set to true then the action don't cache or restore ~/go/pkg."
+    description: "if set to true then the action doesn'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."
+    description: "if set to true then the action doesn't cache or restore ~/.cache/go-build."
     default: false
     required: true
 runs:
-  using: "node12"
+  using: "node16"
   main: "dist/run/index.js"
   post: "dist/post_run/index.js"
 branding:

package.json

@@ -1,12 +1,10 @@
 {
   "name": "golanci-lint-action",
-  "version": "2.0.0",
+  "version": "3.1.0",
   "private": true,
   "description": "golangci-lint github action",
   "main": "dist/main.js",
   "scripts": {
-    "prepare-setup-go": "cd node_modules/setup-go && npm run build",
-    "prepare-deps": "npm run prepare-setup-go",
     "build": "tsc && ncc build -o dist/run/ src/main.ts && ncc build -o dist/post_run/ src/post_main.ts",
     "watched_build_main": "tsc && ncc build -w -o dist/run/ src/main.ts",
     "watched_build_post_main": "tsc && ncc build -w -o dist/post_run/ src/post_main.ts",
@@ -15,7 +13,7 @@
     "lint-fix": "eslint **/*.ts --cache --fix",
     "format": "prettier --write **/*.ts",
     "format-check": "prettier --check **/*.ts",
-    "all": "npm run prepare-deps && npm run build && npm run format-check && npm run lint",
+    "all": "npm run build && npm run format-check && npm run lint",
     "local": "npm run build && act -j test -b",
     "local-full-version": "npm run build && act -j test-full-version -b"
   },
@@ -26,28 +24,25 @@
   "author": "golangci",
   "license": "MIT",
   "dependencies": {
-    "@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.1",
-    "@types/semver": "^7.3.4",
-    "@types/tmp": "^0.2.0",
-    "setup-go": "git+https://github.com/actions/setup-go.git#v2.1.3",
+    "@actions/cache": "^2.0.2",
+    "@actions/core": "^1.8.0",
+    "@actions/exec": "^1.1.1",
+    "@actions/github": "^5.0.1",
+    "@actions/tool-cache": "^1.7.2",
+    "@types/semver": "^7.3.9",
+    "@types/tmp": "^0.2.3",
     "tmp": "^0.2.1"
   },
   "devDependencies": {
-    "@types/node": "^14.14.31",
-    "@types/uuid": "^8.3.0",
-    "@typescript-eslint/eslint-plugin": "^4.15.1",
-    "@typescript-eslint/parser": "^4.15.1",
-    "@zeit/ncc": "^0.22.3",
-    "eslint": "^7.20.0",
-    "eslint-config-prettier": "^8.0.0",
-    "eslint-plugin-import": "^2.22.1",
-    "eslint-plugin-prettier": "^3.3.1",
+    "@typescript-eslint/eslint-plugin": "^5.22.0",
+    "@typescript-eslint/parser": "^5.22.0",
+    "@vercel/ncc": "^0.33.4",
+    "eslint": "^8.15.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-plugin-import": "^2.26.0",
+    "eslint-plugin-prettier": "^4.0.0",
     "eslint-plugin-simple-import-sort": "^7.0.0",
-    "prettier": "^2.2.1",
-    "typescript": "^4.1.5"
+    "prettier": "^2.6.2",
+    "typescript": "^4.6.4"
   }
 }

src/cache.ts

@@ -52,12 +52,9 @@ const getIntervalKey = (invalidationIntervalDays: number): string => {
 
 async function buildCacheKeys(): Promise<string[]> {
   const keys = []
-  let cacheKey = `golangci-lint.cache-`
-  keys.push(cacheKey)
-
   // Periodically invalidate a cache because a new code being added.
   // TODO: configure it via inputs.
-  cacheKey += `${getIntervalKey(7)}-`
+  let cacheKey = `golangci-lint.cache-${getIntervalKey(7)}-`
   keys.push(cacheKey)
 
   if (await pathExists(`go.mod`)) {
@@ -72,6 +69,8 @@ async function buildCacheKeys(): Promise<string[]> {
 }
 
 export async function restoreCache(): Promise<void> {
+  if (core.getInput(`skip-cache`, { required: true }).trim() == "true") return
+
   if (!utils.isValidEvent()) {
     utils.logWarning(
       `Event Validation Error: The event type ${process.env[Events.Key]} is not supported because it's not tied to a branch or tag ref.`
@@ -112,6 +111,8 @@ export async function restoreCache(): Promise<void> {
 }
 
 export async function saveCache(): Promise<void> {
+  if (core.getInput(`skip-cache`, { required: true }).trim() == "true") return
+
   // Validate inputs, this can cause task failure
   if (!utils.isValidEvent()) {
     utils.logWarning(

src/deps.d.ts

@@ -1,7 +1,3 @@
-declare module "setup-go/lib/main" {
-  function run(): Promise<void>
-}
-
 declare module "cache/lib/restore" {
   function run(): Promise<void>
   export default run

src/install.ts

@@ -2,7 +2,6 @@ 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"
 
@@ -59,16 +58,3 @@ export async function installLint(versionConfig: VersionConfig): Promise<string>
   core.info(`Installed golangci-lint into ${lintPath} in ${Date.now() - startedAt}ms`)
   return lintPath
 }
-
-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()
-  core.info(`Installed Go in ${Date.now() - startedAt}ms`)
-}

src/run.ts

@@ -7,7 +7,7 @@ import { dir } from "tmp"
 import { promisify } from "util"
 
 import { restoreCache, saveCache } from "./cache"
-import { installGo, installLint } from "./install"
+import { installLint } from "./install"
 import { findLintVersion } from "./version"
 
 const execShellCommand = promisify(exec)
@@ -41,7 +41,7 @@ async function fetchPatch(): Promise<string> {
   const octokit = github.getOctokit(core.getInput(`github-token`, { required: true }))
   let patch: string
   try {
-    const patchResp = await octokit.pulls.get({
+    const patchResp = await octokit.rest.pulls.get({
       owner: ctx.repo.owner,
       repo: ctx.repo.repo,
       [`pull_number`]: pull.number,
@@ -85,11 +85,9 @@ async function prepareEnv(): Promise<Env> {
   // Prepare cache, lint and go in parallel.
   const restoreCachePromise = restoreCache()
   const prepareLintPromise = prepareLint()
-  const installGoPromise = installGo()
   const patchPromise = fetchPatch()
 
   const lintPath = await prepareLintPromise
-  await installGoPromise
   await restoreCachePromise
   const patchPath = await patchPromise
 
@@ -121,15 +119,14 @@ async function runLint(lintPath: string, patchPath: string): Promise<void> {
   const userArgs = core.getInput(`args`)
   const addedArgs: string[] = []
 
-  const userArgNames = new Set<string>()
-  userArgs
-    .split(/\s/)
-    .map((arg) => arg.split(`=`)[0])
-    .filter((arg) => arg.startsWith(`-`))
-    .forEach((arg) => {
-      userArgNames.add(arg.replace(`-`, ``))
-    })
-
+  const userArgNames = new Set<string>(
+    userArgs
+      .trim()
+      .split(/\s+/)
+      .map((arg) => arg.split(`=`)[0])
+      .filter((arg) => arg.startsWith(`-`))
+      .map((arg) => arg.replace(/^-+/, ``))
+  )
   if (userArgNames.has(`out-format`)) {
     throw new Error(`please, don't change out-format for golangci-lint: it can be broken in a future`)
   }

tsconfig.json

@@ -8,7 +8,8 @@
     "noImplicitAny": true,                    /* Raise error on expressions and declarations with an implied 'any' type. */
     "esModuleInterop": true,                  /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
     "tsBuildInfoFile": ".tsbuildinfo",
-    "incremental": true
+    "incremental": true,
+    "useUnknownInCatchVariables": false
   },
   "exclude": ["node_modules", "**/*.test.ts"]
-}
+}