doc: improve readme

Co-authored-by: Fernandez Ludovic <ldez@users.noreply.github.com>

.github/workflows/codeql.yaml

@@ -16,7 +16,7 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         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@v2
+        uses: github/codeql-action/init@v3
         # 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@v2
+        uses: github/codeql-action/analyze@v3

.github/workflows/test.yml

@@ -11,9 +11,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - if: ${{ !(github.event_name == 'pull_request' && (github.event.pull_request.user.id == 49699333 || contains(github.event.pull_request.labels.*.name, 'dependencies'))) }}
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - if: github.event_name == 'pull_request' && (github.event.pull_request.user.id == 49699333 || contains(github.event.pull_request.labels.*.name, 'dependencies'))
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
           ref: ${{ github.event.pull_request.head.ref }}
@@ -52,17 +52,17 @@ jobs:
         version:
           - ""
           - "latest"
-          - "v1.53"
+          - "v1.58"
-          - "v1.53.2"
+          - "v1.58.0"
     runs-on: ${{ matrix.os }}
     permissions:
       contents: read
       pull-requests: read
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
-      - uses: actions/setup-go@v4
+      - uses: actions/setup-go@v5
         with:
-          cache: false # setup-go v4 caches by default
+          go-version: oldstable
       - uses: ./
         with:
           version: ${{ matrix.version }}
@@ -80,17 +80,17 @@ jobs:
         version:
           - ""
           - "latest"
-          - "v1.53.2"
+          - "v1.58.0"
-          - "b5093688c0d3008eaacd6066773a1a52e689252f"
+          - "4bf574a12bb61234e28e3d6172be6ed95b0e8baf"
     runs-on: ${{ matrix.os }}
     permissions:
       contents: read
       pull-requests: read
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
-      - uses: actions/setup-go@v4
+      - uses: actions/setup-go@v5
         with:
-          cache: false # setup-go v4 caches by default
+          go-version: oldstable
       - uses: ./
         with:
           version: ${{ matrix.version }}
@@ -110,10 +110,10 @@ jobs:
     permissions:
       contents: read
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
-      - uses: actions/setup-go@v4
+      - uses: actions/setup-go@v5
         with:
-          cache: false # setup-go v4 caches by default
+          go-version: oldstable
       - uses: ./
         with:
           working-directory: sample-go-mod

README.md

@@ -3,13 +3,18 @@
 [![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 its authors.
+
 The action runs [golangci-lint](https://github.com/golangci/golangci-lint) and reports issues from linters.
 
 ![GitHub Annotations](./static/annotations.png)
 
+![Logs](./static/colored-line-number.png)
+
 ## Compatibility
 
-* `v3.0.0+` requires explicit setup-go installation step prior to using this action: `uses: actions/setup-go@v3`.
+* `v6.0.0+` removes `annotations` option, removes the default output format (`github-actions`).
+* `v5.0.0+` removes `skip-pkg-cache` and `skip-build-cache` because the cache related to Go itself is already handled by `actions/setup-go`.
+* `v4.0.0+` requires an explicit `actions/setup-go` installation step before using this action: `uses: actions/setup-go@v5`.
   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))
@@ -24,8 +29,8 @@ name: golangci-lint
 on:
   push:
     branches:
-      - master
       - main
+      - master
   pull_request:
 
 permissions:
@@ -38,59 +43,32 @@ jobs:
     name: lint
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
-      - uses: actions/setup-go@v4
+      - uses: actions/setup-go@v5
         with:
-          go-version: '1.20'
+          go-version: '1.22'
-          cache: false
       - name: golangci-lint
-        uses: golangci/golangci-lint-action@v3
+        uses: golangci/golangci-lint-action@v5
         with:
-          # Require: The version of golangci-lint to use.
+          version: latest
-          # When `install-mode` is `binary` (default) the value can be v1.2 or v1.2.3 or `latest` to use the latest version.
-          # When `install-mode` is `goinstall` the value can be v1.2.3, `latest`, or the hash of a commit.
-          version: v1.53
-
-          # Optional: working directory, useful for monorepos
-          # working-directory: somedir
-
-          # Optional: golangci-lint command line arguments.
-          #
-          # Note: By default, the `.golangci.yml` file should be at the root of the repository.
-          # The location of the configuration file can be changed by using `--config=`
-          # args: --timeout=30m --config=/my/path/.golangci.yml --issues-exit-code=0 
-
-          # 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 all caching functionality will be completely disabled,
-          #           takes precedence over all other caching options.
-          # skip-cache: true
-
-          # Optional: if set to true, then the action won't cache or restore ~/go/pkg.
-          # skip-pkg-cache: true
-
-          # Optional: if set to true, then the action won't cache or restore ~/.cache/go-build.
-          # skip-build-cache: true
-
-          # Optional: The mode to install golangci-lint. It can be 'binary' or 'goinstall'.
-          # install-mode: "goinstall"
 ```
 
-We recommend running this action in a job separate from other jobs (`go test`, etc)
+We recommend running this action in a job separate from other jobs (`go test`, etc.)
 because different jobs [run in parallel](https://help.github.com/en/actions/getting-started-with-github-actions/core-concepts-for-github-actions#job).
 
 ### Multiple OS Support
 
-If you need to run linters for specific operating systems, you will need to use `v2` of the action.  Here is a sample configuration file:
+If you need to run linters for specific operating systems, you will need to use the action `>=v2`.
+
+Here is a sample configuration file:
 
 ```yaml
 name: golangci-lint
 on:
   push:
     branches:
-      - master
       - main
+      - master
   pull_request:
 
 permissions:
@@ -102,62 +80,208 @@ jobs:
   golangci:
     strategy:
       matrix:
-        go: ['1.20']
+        go: ['1.22']
-        os: [macos-latest, windows-latest]
+        os: [ubuntu-latest, macos-latest, windows-latest]
     name: lint
     runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
-      - uses: actions/setup-go@v4
+      - uses: actions/setup-go@v5
         with:
           go-version: ${{ matrix.go }}
-          cache: false
       - name: golangci-lint
-        uses: golangci/golangci-lint-action@v3
+        uses: golangci/golangci-lint-action@v5
         with:
-          # Require: The version of golangci-lint to use.
+          version: latest
-          # When `install-mode` is `binary` (default) the value can be v1.2 or v1.2.3 or `latest` to use the latest version.
-          # When `install-mode` is `goinstall` the value can be v1.2.3, `latest`, or the hash of a commit.
-          version: v1.53
-
-          # Optional: working directory, useful for monorepos
-          # working-directory: somedir
-
-          # Optional: golangci-lint command line arguments.
-          # 
-          # Note: by default the `.golangci.yml` file should be at the root of the repository.
-          # The location of the configuration file can be changed by using `--config=`
-          # args: --timeout=30m --config=/my/path/.golangci.yml --issues-exit-code=0
-
-          # Optional: show only new issues if it's a pull request. The default value is `false`.
-          # only-new-issues: true
-
-          # Optional:The mode to install golangci-lint. It can be 'binary' or 'goinstall'.
-          # install-mode: "goinstall"
 ```
 
-You will also likely need to add the following `.gitattributes` file to ensure that line endings for windows builds are properly formatted:
+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
 ```
 
-## Comments and Annotations
+## Options
 
-Currently, GitHub parses the action's output and creates [annotations](https://github.community/t5/GitHub-Actions/What-are-annotations/td-p/30770).
+### `version`
+
+(required)
+
+The version of golangci-lint to use.
+
+* When `install-mode` is `binary` (default) the value can be v1.2 or v1.2.3 or `latest` to use the latest version.
+* When `install-mode` is `goinstall` the value can be v1.2.3, `latest`, or the hash of a commit.
+
+```yml
+uses: golangci/golangci-lint-action@v5
+with:
+  version: latest
+  # ...
+```
+
+### `install-mode`
+
+(optional)
+
+The mode to install golangci-lint: it can be `binary` or `goinstall`.
+
+The default value is `binary`.
+
+```yml
+uses: golangci/golangci-lint-action@v5
+with:
+  install-mode: "goinstall"
+  # ...
+```
+
+### `only-new-issues`
+
+(optional)
+
+Show only new issues.
+
+The default value is `false`.
+
+```yml
+uses: golangci/golangci-lint-action@v5
+with:
+  only-new-issues: true
+  # ...
+```
+
+* `pull_request` and `pull_request_target`: the action gets the diff of the PR content from the [GitHub API](https://docs.github.com/en/rest/pulls/pulls?apiVersion=2022-11-28#get-a-pull-request) and use it with `--new-from-patch`.
+* `push`: the action gets the diff of the push content (difference between commits before and after the push) from the [GitHub API](https://docs.github.com/en/rest/commits/commits?apiVersion=2022-11-28#compare-two-commits) and use it with `--new-from-patch`.
+* `merge_group`: the action gets the diff by using `--new-from-rev` option (relies on git).
+   You should add the option `fetch-depth: 0` to `actions/checkout` step.
+
+### `working-directory`
+
+(optional)
+
+Working directory, useful for monorepos.
+
+```yml
+uses: golangci/golangci-lint-action@v5
+with:
+  working-directory: somedir
+  # ...
+```
+
+### `skip-cache`
+
+(optional)
+
+If set to `true`, then all caching functionality will be completely disabled,
+takes precedence over all other caching options.
+
+The default value is `false`.
+
+```yml
+uses: golangci/golangci-lint-action@v5
+with:
+  skip-cache: true
+  # ...
+```
+
+### `skip-save-cache`
+
+(optional)
+
+If set to `true`, caches will not be saved, but they may still be restored, required `skip-cache: false`.
+
+The default value is `false`.
+
+```yml
+uses: golangci/golangci-lint-action@v5
+with:
+  skip-save-cache: true
+  # ...
+```
+
+### `cache-invalidation-interval`
+
+(optional)
+
+Periodically invalidate the cache every `cache-invalidation-interval` days to ensure that outdated data is removed and fresh data is loaded.
+
+The default value is `7`.
+
+```yml
+uses: golangci/golangci-lint-action@v5
+with:
+  cache-invalidation-interval: 15
+  # ...
+```
+
+If set the number is `<= 0`, the cache will be always invalidate (Not recommended).
+
+### `problem-matchers`
+
+(optional)
+
+Force the usage of the embedded problem matchers.
+
+By default, the [problem matcher of Go (`actions/setup-go`)](https://github.com/actions/setup-go/blob/main/matchers.json) already handles the golangci-lint output (`colored-line-number`). 
+
+Works only with `colored-line-number` (the golangci-lint default).
+
+https://golangci-lint.run/usage/configuration/#output-configuration
+
+The default value is `false`.
+
+```yml
+uses: golangci/golangci-lint-action@v5
+with:
+  problem-matchers: true
+  # ...
+```
+
+### `args`
+
+(optional)
+
+golangci-lint command line arguments.
+
+Note: By default, the `.golangci.yml` file should be at the root of the repository.
+The location of the configuration file can be changed by using `--config=`
+
+```yml
+uses: golangci/golangci-lint-action@v5
+with:
+  args: --timeout=30m --config=/my/path/.golangci.yml --issues-exit-code=0
+  # ...
+```
+
+## Annotations
+
+Currently, GitHub parses the action's output and creates [annotations](https://github.blog/2018-12-14-introducing-check-runs-and-annotations/).
 
 The restrictions of annotations are the following:
 
-1. Currently, they don't support markdown formatting (see the [feature request](https://github.community/t5/GitHub-API-Development-and/Checks-Ability-to-include-Markdown-in-line-annotations/m-p/56704))
+1. Currently, they don't support Markdown formatting (see the [feature request](https://github.community/t5/GitHub-API-Development-and/Checks-Ability-to-include-Markdown-in-line-annotations/m-p/56704))
-2. They aren't shown in list of comments like it was with [golangci.com](https://golangci.com). If you would like to have comments - please, up-vote [the issue](https://github.com/golangci/golangci-lint-action/issues/5).
+2. They aren't shown in the list of comments.
+   If you would like to have comments - please, up-vote [the issue](https://github.com/golangci/golangci-lint-action/issues/5).
+3. The number of annotations is [limited](https://github.com/actions/toolkit/blob/main/docs/problem-matchers.md#limitations).
+
+To enable annotations, you need to add the `checks` permission to your action.
+
+```yaml annotate
+permissions:
+  # Required: allow read access to the content for analysis.
+  contents: read
+  # Optional: allow read access to pull request. Use with `only-new-issues` option.
+  pull-requests: read
+  # Optional: allow write access to checks to allow the action to annotate code in the PR.
+  checks: write
+```
 
 ## Performance
 
 The action was implemented with performance in mind:
 
-1. We cache data by [@actions/cache](https://github.com/actions/toolkit/tree/master/packages/cache) between builds: Go build cache, Go modules cache, golangci-lint analysis cache.
+1. We cache data from golangci-lint analysis between builds by using [@actions/cache](https://github.com/actions/toolkit/tree/master/packages/cache). 
 2. We don't use Docker because image pulling is slow.
-3. We do as much as we can in parallel, e.g. we download cache, go and golangci-lint binary in parallel.
+3. We do as much as we can in parallel, e.g. we download cache, and golangci-lint binary in parallel.
 
 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:
@@ -167,28 +291,33 @@ For example, in a repository of [golangci-lint](https://github.com/golangci/gola
 
 ## Internals
 
-We use JavaScript-based action. We don't use Docker-based action because:
+We use JavaScript-based action.
+We don't use Docker-based action because:
 
-1. docker pulling is slow currently
+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.
+We support different platforms, such as `ubuntu`, `macos`, and `windows` with `x32` and `x64` archs.
 
-Inside our action we perform 3 steps:
+Inside our action, we perform 3 steps:
 
 1. Setup environment running in parallel:
-  * restore [cache](https://github.com/actions/cache) of previous analyzes
+   * restore [cache](https://github.com/actions/cache) of previous analyses
-  * fetch [action config](https://github.com/golangci/golangci-lint/blob/master/assets/github-action-config.json) and find the latest `golangci-lint` patch version
+   * 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
-    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)
+     (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)
 2. Run `golangci-lint` with specified by user `args`
 3. Save cache for later builds
 
 ### Caching internals
 
-1. We save and restore the following directories: `~/.cache/golangci-lint`, `~/.cache/go-build`, `~/go/pkg`.
+1. We save and restore the following directory: `~/.cache/golangci-lint`.
-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-{runner_os}-{working_directory}-{interval_number}-{go.mod_hash}`.
-   our cache (every 7 days). `go.mod` hash ensures that we invalidate the cache early - as soon as dependencies have changed.
+   Interval number ensures that we periodically invalidate our cache (every 7 days).
-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}-`. GitHub matches keys by prefix if we have no exact match for the primary cache.
+   `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-{runner_os}-{working_directory}-{interval_number}-`.
+   GitHub matches keys by prefix if we have no exact match for the primary cache.
 
 This scheme is basic and needs improvements. Pull requests and ideas are welcome.
 

action.yml

@@ -1,4 +1,5 @@
-name: "Run golangci-lint"
+# https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions
+name: "Golangci-lint"
 description: "Official golangci-lint action with line-attached annotations for found issues, caching and parallel execution."
 author: "golangci"
 inputs:
@@ -8,9 +9,9 @@ inputs:
       When `install-mode` is `binary` (default) the value can be v1.2 or v1.2.3 or `latest` to use the latest version.
       When `install-mode` is `goinstall` the value can be v1.2.3, `latest`, or the hash of a commit.
     required: false
-  args:
+  install-mode:
-    description: "golangci-lint command line arguments"
+    description: "The mode to install golangci-lint. It can be 'binary' or 'goinstall'."
-    default: ""
+    default: "binary"
     required: false
   working-directory:
     description: "golangci-lint working directory, default is project root"
@@ -29,22 +30,28 @@ inputs:
       takes precedence over all other caching options.
     default: 'false'
     required: false
-  skip-pkg-cache:
+  skip-save-cache:
-    description: "if set to true then the action doesn't cache or restore ~/go/pkg."
+    description: |
+      if set to true then the action will not save any caches, but it may still
+      restore existing caches, subject to other options.
     default: 'false'
     required: false
-  skip-build-cache:
+  problem-matchers:
-    description: "if set to true then the action doesn't cache or restore ~/.cache/go-build."
+    description: "Force the usage of the embedded problem matchers"
     default: 'false'
     required: false
-  install-mode:
+  args:
-    description: "The mode to install golangci-lint. It can be 'binary' or 'goinstall'."
+    description: "golangci-lint command line arguments"
-    default: "binary"
+    default: ""
+    required: false
+  cache-invalidation-interval:
+    description: "Periodically invalidate a cache because a new code being added. (number of days)"
+    default: '7'
     required: false
 runs:
-  using: "node16"
+  using: "node20"
   main: "dist/run/index.js"
   post: "dist/post_run/index.js"
 branding:
   icon: "shield"
-  color: "yellow"
+  color: "white"

package.json

@@ -24,27 +24,27 @@
   "author": "golangci",
   "license": "MIT",
   "dependencies": {
-    "@actions/cache": "^3.2.2",
+    "@actions/cache": "^3.2.4",
-    "@actions/core": "^1.10.0",
+    "@actions/core": "^1.10.1",
     "@actions/exec": "^1.1.1",
-    "@actions/github": "^5.1.1",
+    "@actions/github": "^6.0.0",
-    "@actions/http-client": "^2.1.1",
+    "@actions/http-client": "^2.2.1",
     "@actions/tool-cache": "^2.0.1",
-    "@types/node": "^20.5.0",
+    "@types/node": "^20.12.8",
-    "@types/semver": "^7.5.0",
+    "@types/semver": "^7.5.8",
-    "@types/tmp": "^0.2.3",
+    "@types/tmp": "^0.2.6",
-    "tmp": "^0.2.1"
+    "tmp": "^0.2.3"
   },
   "devDependencies": {
-    "@typescript-eslint/eslint-plugin": "^6.3.0",
+    "@typescript-eslint/eslint-plugin": "^7.8.0",
-    "@typescript-eslint/parser": "^6.3.0",
+    "@typescript-eslint/parser": "^7.8.0",
-    "@vercel/ncc": "^0.36.1",
+    "@vercel/ncc": "^0.38.1",
-    "eslint": "^8.47.0",
+    "eslint": "^8.57.0",
-    "eslint-config-prettier": "^9.0.0",
+    "eslint-config-prettier": "^9.1.0",
-    "eslint-plugin-import": "^2.28.0",
+    "eslint-plugin-import": "^2.29.1",
-    "eslint-plugin-prettier": "^5.0.0",
+    "eslint-plugin-prettier": "^5.1.3",
-    "eslint-plugin-simple-import-sort": "^10.0.0",
+    "eslint-plugin-simple-import-sort": "^12.1.0",
-    "prettier": "^3.0.1",
+    "prettier": "^3.2.5",
-    "typescript": "^5.1.6"
+    "typescript": "^5.4.5"
   }
 }

problem-matchers.json

@@ -0,0 +1,17 @@
+{
+  "problemMatcher": [
+    {
+      "owner": "golangci-lint-colored-line-number",
+      "severity": "error",
+      "pattern": [
+        {
+          "regexp": "^([^:]+):(\\d+):(?:(\\d+):)?\\s+(.+ \\(.+\\))$",
+          "file": 1,
+          "line": 2,
+          "column": 3,
+          "message": 4
+        }
+      ]
+    }
+  ]
+}

sample-go-mod/go.mod

@@ -167,7 +167,7 @@ require (
 	golang.org/x/sys v0.5.0 // indirect
 	golang.org/x/text v0.6.0 // indirect
 	golang.org/x/tools v0.6.0 // indirect
-	google.golang.org/protobuf v1.28.0 // indirect
+	google.golang.org/protobuf v1.33.0 // indirect
 	gopkg.in/ini.v1 v1.67.0 // indirect
 	gopkg.in/yaml.v2 v2.4.0 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect

sample-go-mod/go.sum

@@ -924,8 +924,8 @@ google.golang.org/protobuf v1.24.0/go.mod h1:r/3tXBNzIEhYS9I1OUVjXDlt8tc493IdKGj
 google.golang.org/protobuf v1.25.0/go.mod h1:9JNX74DMeImyA3h4bdi1ymwjUzf21/xIlbajtzgsN7c=
 google.golang.org/protobuf v1.26.0-rc.1/go.mod h1:jlhhOSvTdKEhbULTjvd4ARK9grFBp09yW+WbY/TyQbw=
 google.golang.org/protobuf v1.26.0/go.mod h1:9q0QmTI4eRPtz6boOQmLYwt+qCgq0jsYwAQnmE0givc=
-google.golang.org/protobuf v1.28.0 h1:w43yiav+6bVFTBQFZX0r7ipe9JQ1QsbMgHwbBziscLw=
+google.golang.org/protobuf v1.33.0 h1:uNO2rsAINq/JlFpSdYEKIZ0uKD/R9cpdv0T+yoGwGmI=
-google.golang.org/protobuf v1.28.0/go.mod h1:HV8QOd/L58Z+nl8r43ehVNZIU/HEI6OcFqwMG9pJV4I=
+google.golang.org/protobuf v1.33.0/go.mod h1:c6P6GXX6sHbq/GpV6MGZEdwhWPcYBgnhAHhKbcUYpos=
 gopkg.in/alecthomas/kingpin.v2 v2.2.6/go.mod h1:FMv+mEhP44yOT+4EoQTLFTRgOQ1FBLkstjWtayDeSgw=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=

src/cache.ts

@@ -23,28 +23,13 @@ const getLintCacheDir = (): string => {
   return path.resolve(`${process.env.HOME}/.cache/golangci-lint`)
 }
 
-const getCacheDirs = (): string[] => {
-  // Not existing dirs are ok here: it works.
-  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 => {
   const now = new Date()
+
+  if (invalidationIntervalDays <= 0) {
+    return `${now.getTime()}`
+  }
+
   const secondsSinceEpoch = now.getTime() / 1000
   const intervalNumber = Math.floor(secondsSinceEpoch / (invalidationIntervalDays * 86400))
   return intervalNumber.toString()
@@ -52,28 +37,42 @@ const getIntervalKey = (invalidationIntervalDays: number): string => {
 
 async function buildCacheKeys(): Promise<string[]> {
   const keys = []
-  // Periodically invalidate a cache because a new code being added.
+
-  // TODO: configure it via inputs.
+  // Cache by OS.
-  let cacheKey = `golangci-lint.cache-${getIntervalKey(7)}-`
+  let cacheKey = `golangci-lint.cache-${process.env?.RUNNER_OS}-`
-  keys.push(cacheKey)
+
   // Get working directory from input
   const workingDirectory = core.getInput(`working-directory`)
+
+  if (workingDirectory) {
+    cacheKey += `${workingDirectory}-`
+  }
+
+  // Periodically invalidate a cache because a new code being added.
+  const invalidationIntervalDays = parseInt(core.getInput(`cache-invalidation-interval`, { required: true }).trim())
+  cacheKey += `${getIntervalKey(invalidationIntervalDays)}-`
+
+  keys.push(cacheKey)
+
   // create path to go.mod prepending the workingDirectory if it exists
   const goModPath = path.join(workingDirectory, `go.mod`)
+
   core.info(`Checking for go.mod: ${goModPath}`)
+
   if (await pathExists(goModPath)) {
     // Add checksum to key to invalidate a cache when dependencies change.
     cacheKey += await checksumFile(`sha1`, goModPath)
   } else {
     cacheKey += `nogomod`
   }
+
   keys.push(cacheKey)
 
   return keys
 }
 
 export async function restoreCache(): Promise<void> {
-  if (core.getInput(`skip-cache`, { required: true }).trim() == "true") return
+  if (core.getBooleanInput(`skip-cache`, { required: true })) return
 
   if (!utils.isValidEvent()) {
     utils.logWarning(
@@ -97,7 +96,7 @@ export async function restoreCache(): Promise<void> {
   }
   core.saveState(State.CachePrimaryKey, primaryKey)
   try {
-    const cacheKey = await cache.restoreCache(getCacheDirs(), primaryKey, restoreKeys)
+    const cacheKey = await cache.restoreCache([getLintCacheDir()], primaryKey, restoreKeys)
     if (!cacheKey) {
       core.info(`Cache not found for input keys: ${[primaryKey, ...restoreKeys].join(", ")}`)
       return
@@ -115,7 +114,8 @@ export async function restoreCache(): Promise<void> {
 }
 
 export async function saveCache(): Promise<void> {
-  if (core.getInput(`skip-cache`, { required: true }).trim() == "true") return
+  if (core.getBooleanInput(`skip-cache`, { required: true })) return
+  if (core.getBooleanInput(`skip-save-cache`, { required: true })) return
 
   // Validate inputs, this can cause task failure
   if (!utils.isValidEvent()) {
@@ -127,7 +127,7 @@ export async function saveCache(): Promise<void> {
 
   const startedAt = Date.now()
 
-  const cacheDirs = getCacheDirs()
+  const cacheDirs = [getLintCacheDir()]
   const primaryKey = core.getState(State.CachePrimaryKey)
   if (!primaryKey) {
     utils.logWarning(`Error retrieving key from state.`)

src/run.ts

@@ -1,5 +1,6 @@
 import * as core from "@actions/core"
 import * as github from "@actions/github"
+import { Context } from "@actions/github/lib/context"
 import { exec, ExecOptions } from "child_process"
 import * as fs from "fs"
 import * as path from "path"
@@ -15,6 +16,10 @@ const execShellCommand = promisify(exec)
 const writeFile = promisify(fs.writeFile)
 const createTempDir = promisify(dir)
 
+function isOnlyNewIssues(): boolean {
+  return core.getBooleanInput(`only-new-issues`, { required: true })
+}
+
 async function prepareLint(): Promise<string> {
   const mode = core.getInput("install-mode").toLowerCase()
   const versionConfig = await findLintVersion(<InstallMode>mode)
@@ -23,31 +28,42 @@ async function prepareLint(): Promise<string> {
 }
 
 async function fetchPatch(): Promise<string> {
-  const onlyNewIssues = core.getInput(`only-new-issues`, { required: true }).trim()
+  if (!isOnlyNewIssues()) {
-  if (onlyNewIssues !== `false` && onlyNewIssues !== `true`) {
-    throw new Error(`invalid value of "only-new-issues": "${onlyNewIssues}", expected "true" or "false"`)
-  }
-  if (onlyNewIssues === `false`) {
     return ``
   }
 
   const ctx = github.context
-  if (ctx.eventName !== `pull_request`) {
+
+  switch (ctx.eventName) {
+    case `pull_request`:
+    case `pull_request_target`:
+      return await fetchPullRequestPatch(ctx)
+    case `push`:
+      return await fetchPushPatch(ctx)
+    case `merge_group`:
+      core.info(JSON.stringify(ctx.payload))
+      return ``
+    default:
       core.info(`Not fetching patch for showing only new issues because it's not a pull request context: event name is ${ctx.eventName}`)
       return ``
   }
-  const pull = ctx.payload.pull_request
+}
-  if (!pull) {
+
+async function fetchPullRequestPatch(ctx: Context): Promise<string> {
+  const pr = ctx.payload.pull_request
+  if (!pr) {
     core.warning(`No pull request in context`)
     return ``
   }
+
   const octokit = github.getOctokit(core.getInput(`github-token`, { required: true }))
+
   let patch: string
   try {
     const patchResp = await octokit.rest.pulls.get({
       owner: ctx.repo.owner,
       repo: ctx.repo.repo,
-      [`pull_number`]: pull.number,
+      [`pull_number`]: pr.number,
       mediaType: {
         format: `diff`,
       },
@@ -77,6 +93,44 @@ async function fetchPatch(): Promise<string> {
   }
 }
 
+async function fetchPushPatch(ctx: Context): Promise<string> {
+  const octokit = github.getOctokit(core.getInput(`github-token`, { required: true }))
+
+  let patch: string
+  try {
+    const patchResp = await octokit.rest.repos.compareCommitsWithBasehead({
+      owner: ctx.repo.owner,
+      repo: ctx.repo.repo,
+      basehead: `${ctx.payload.before}..${ctx.payload.after}`,
+      mediaType: {
+        format: `diff`,
+      },
+    })
+
+    if (patchResp.status !== 200) {
+      core.warning(`failed to fetch push patch: response status is ${patchResp.status}`)
+      return `` // don't fail the action, but analyze without patch
+    }
+
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    patch = patchResp.data as any
+  } catch (err) {
+    console.warn(`failed to fetch push patch:`, err)
+    return `` // don't fail the action, but analyze without patch
+  }
+
+  try {
+    const tempDir = await createTempDir()
+    const patchPath = path.join(tempDir, "push.patch")
+    core.info(`Writing patch to ${patchPath}`)
+    await writeFile(patchPath, alterDiffPatch(patch))
+    return patchPath
+  } catch (err) {
+    console.warn(`failed to save pull request patch:`, err)
+    return `` // don't fail the action, but analyze without patch
+  }
+}
+
 type Env = {
   lintPath: string
   patchPath: string
@@ -87,11 +141,9 @@ async function prepareEnv(): Promise<Env> {
 
   // Prepare cache, lint and go in parallel.
   await restoreCache()
-  const prepareLintPromise = prepareLint()
-  const patchPromise = fetchPatch()
 
-  const lintPath = await prepareLintPromise
+  const lintPath = await prepareLint()
-  const patchPath = await patchPromise
+  const patchPath = await fetchPatch()
 
   core.info(`Prepared env in ${Date.now() - startedAt}ms`)
 
@@ -133,30 +185,68 @@ async function runLint(lintPath: string, patchPath: string): Promise<void> {
   const userArgsMap = new Map<string, string>(userArgsList)
   const userArgNames = new Set<string>(userArgsList.map(([key]) => key))
 
+  const problemMatchers = core.getBooleanInput(`problem-matchers`)
+
+  if (problemMatchers) {
+    const matchersPath = path.join(__dirname, "../..", "problem-matchers.json")
+    if (fs.existsSync(matchersPath)) {
+      // Adds problem matchers.
+      // https://github.com/actions/setup-go/blob/cdcb36043654635271a94b9a6d1392de5bb323a7/src/main.ts#L81-L83
+      core.info(`##[add-matcher]${matchersPath}`)
+    }
+  }
+
   const formats = (userArgsMap.get("out-format") || "")
     .trim()
     .split(",")
     .filter((f) => f.length > 0)
-    .filter((f) => !f.startsWith(`github-actions`))
+    .filter((f) => !f.startsWith(`github-actions`)) // Removes `github-actions` format.
-    .concat("github-actions")
     .join(",")
 
+  if (formats) {
+    // Adds formats but without `github-actions` format.
     addedArgs.push(`--out-format=${formats}`)
+  }
+
+  // Removes `--out-format` from the user flags because it's already inside `addedArgs`.
   userArgs = userArgs.replace(/--out-format=\S*/gi, "").trim()
 
-  if (patchPath) {
+  if (isOnlyNewIssues()) {
     if (userArgNames.has(`new`) || userArgNames.has(`new-from-rev`) || userArgNames.has(`new-from-patch`)) {
       throw new Error(`please, don't specify manually --new* args when requesting only new issues`)
     }
+
+    const ctx = github.context
+
+    core.info(`only new issues on ${ctx.eventName}: ${patchPath}`)
+
+    switch (ctx.eventName) {
+      case `pull_request`:
+      case `pull_request_target`:
+      case `push`:
+        if (patchPath) {
           addedArgs.push(`--new-from-patch=${patchPath}`)
 
           // Override config values.
           addedArgs.push(`--new=false`)
           addedArgs.push(`--new-from-rev=`)
         }
+        break
+      case `merge_group`:
+        addedArgs.push(`--new-from-rev=${ctx.payload.merge_group.base_sha}`)
+
+        // Override config values.
+        addedArgs.push(`--new=false`)
+        addedArgs.push(`--new-from-patch=`)
+        break
+      default:
+        break
+    }
+  }
+
+  const cmdArgs: ExecOptions = {}
 
   const workingDirectory = core.getInput(`working-directory`)
-  const cmdArgs: ExecOptions = {}
   if (workingDirectory) {
     if (!fs.existsSync(workingDirectory) || !fs.lstatSync(workingDirectory).isDirectory()) {
       throw new Error(`working-directory (${workingDirectory}) was not a path`)
@@ -169,7 +259,7 @@ async function runLint(lintPath: string, patchPath: string): Promise<void> {
 
   const cmd = `${lintPath} run ${addedArgs.join(` `)} ${userArgs}`.trimEnd()
 
-  core.info(`Running [${cmd}] in [${cmdArgs.cwd || ``}] ...`)
+  core.info(`Running [${cmd}] in [${cmdArgs.cwd || process.cwd()}] ...`)
 
   const startedAt = Date.now()
   try {