Compare commits
26 Commits
Author | SHA1 | Date | |
---|---|---|---|
38e1018663 | |||
21e9e6b47f | |||
dbe4fc23f1 | |||
dbb7ebcd4c | |||
ecb32920c6 | |||
046435d14c | |||
ca8befdfb6 | |||
d9c9b53e53 | |||
aebff4bd9c | |||
2bff406277 | |||
7a6f31107b | |||
57c4c9d189 | |||
3519a25e89 | |||
d073fb8ea7 | |||
9d1e0624a7 | |||
692c9c9dba | |||
ef6d5d0e99 | |||
d149ece3f4 | |||
f89fd48199 | |||
47ef1b2e7f | |||
7c0f80cbb8 | |||
3adb6d0473 | |||
03a8ce6d60 | |||
82d40c283a | |||
c683728f10 | |||
bf6479d5ec |
11
.github/workflows/test.yml
vendored
11
.github/workflows/test.yml
vendored
@ -52,8 +52,8 @@ jobs:
|
|||||||
version:
|
version:
|
||||||
- ""
|
- ""
|
||||||
- "latest"
|
- "latest"
|
||||||
- "v1.56"
|
- "v1.58"
|
||||||
- "v1.56.1"
|
- "v1.58.0"
|
||||||
runs-on: ${{ matrix.os }}
|
runs-on: ${{ matrix.os }}
|
||||||
permissions:
|
permissions:
|
||||||
contents: read
|
contents: read
|
||||||
@ -63,7 +63,6 @@ jobs:
|
|||||||
- uses: actions/setup-go@v5
|
- uses: actions/setup-go@v5
|
||||||
with:
|
with:
|
||||||
go-version: oldstable
|
go-version: oldstable
|
||||||
cache: false # setup-go v4 caches by default
|
|
||||||
- uses: ./
|
- uses: ./
|
||||||
with:
|
with:
|
||||||
version: ${{ matrix.version }}
|
version: ${{ matrix.version }}
|
||||||
@ -81,8 +80,8 @@ jobs:
|
|||||||
version:
|
version:
|
||||||
- ""
|
- ""
|
||||||
- "latest"
|
- "latest"
|
||||||
- "v1.56.1"
|
- "v1.58.0"
|
||||||
- "bf5008a11acf2da5fe76716eb21d808499e079fa"
|
- "4bf574a12bb61234e28e3d6172be6ed95b0e8baf"
|
||||||
runs-on: ${{ matrix.os }}
|
runs-on: ${{ matrix.os }}
|
||||||
permissions:
|
permissions:
|
||||||
contents: read
|
contents: read
|
||||||
@ -92,7 +91,6 @@ jobs:
|
|||||||
- uses: actions/setup-go@v5
|
- uses: actions/setup-go@v5
|
||||||
with:
|
with:
|
||||||
go-version: oldstable
|
go-version: oldstable
|
||||||
cache: false # setup-go v4 caches by default
|
|
||||||
- uses: ./
|
- uses: ./
|
||||||
with:
|
with:
|
||||||
version: ${{ matrix.version }}
|
version: ${{ matrix.version }}
|
||||||
@ -116,7 +114,6 @@ jobs:
|
|||||||
- uses: actions/setup-go@v5
|
- uses: actions/setup-go@v5
|
||||||
with:
|
with:
|
||||||
go-version: oldstable
|
go-version: oldstable
|
||||||
cache: false # setup-go v4 caches by default
|
|
||||||
- uses: ./
|
- uses: ./
|
||||||
with:
|
with:
|
||||||
working-directory: sample-go-mod
|
working-directory: sample-go-mod
|
||||||
|
265
README.md
265
README.md
@ -3,13 +3,15 @@
|
|||||||
[](https://github.com/golangci/golangci-lint-action/actions)
|
[](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.
|
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.
|
The action runs [golangci-lint](https://github.com/golangci/golangci-lint) and reports issues from linters.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
## Compatibility
|
## Compatibility
|
||||||
|
|
||||||
* `v4.0.0+` requires an explicit setup-go installation step before using this action: `uses: actions/setup-go@v5`.
|
* `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.
|
The `skip-go-installation` option has been removed.
|
||||||
* `v2.0.0+` works with `golangci-lint` version >= `v1.28.3`
|
* `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.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 +26,8 @@ name: golangci-lint
|
|||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
branches:
|
branches:
|
||||||
- master
|
|
||||||
- main
|
- main
|
||||||
|
- master
|
||||||
pull_request:
|
pull_request:
|
||||||
|
|
||||||
permissions:
|
permissions:
|
||||||
@ -41,56 +43,29 @@ jobs:
|
|||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
- uses: actions/setup-go@v5
|
- uses: actions/setup-go@v5
|
||||||
with:
|
with:
|
||||||
go-version: '1.21'
|
go-version: '1.22'
|
||||||
cache: false
|
|
||||||
- name: golangci-lint
|
- name: golangci-lint
|
||||||
uses: golangci/golangci-lint-action@v4
|
uses: golangci/golangci-lint-action@v5
|
||||||
with:
|
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.54
|
|
||||||
|
|
||||||
# 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).
|
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
|
### Multiple OS Support
|
||||||
|
|
||||||
If you need to run linters for specific operating systems, you will need to use the action `>=v2`. 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
|
```yaml
|
||||||
name: golangci-lint
|
name: golangci-lint
|
||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
branches:
|
branches:
|
||||||
- master
|
|
||||||
- main
|
- main
|
||||||
|
- master
|
||||||
pull_request:
|
pull_request:
|
||||||
|
|
||||||
permissions:
|
permissions:
|
||||||
@ -102,8 +77,8 @@ jobs:
|
|||||||
golangci:
|
golangci:
|
||||||
strategy:
|
strategy:
|
||||||
matrix:
|
matrix:
|
||||||
go: ['1.21']
|
go: ['1.22']
|
||||||
os: [macos-latest, windows-latest]
|
os: [ubuntu-latest, macos-latest, windows-latest]
|
||||||
name: lint
|
name: lint
|
||||||
runs-on: ${{ matrix.os }}
|
runs-on: ${{ matrix.os }}
|
||||||
steps:
|
steps:
|
||||||
@ -111,29 +86,10 @@ jobs:
|
|||||||
- uses: actions/setup-go@v5
|
- uses: actions/setup-go@v5
|
||||||
with:
|
with:
|
||||||
go-version: ${{ matrix.go }}
|
go-version: ${{ matrix.go }}
|
||||||
cache: false
|
|
||||||
- name: golangci-lint
|
- name: golangci-lint
|
||||||
uses: golangci/golangci-lint-action@v4
|
uses: golangci/golangci-lint-action@v5
|
||||||
with:
|
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.54
|
|
||||||
|
|
||||||
# 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:
|
||||||
@ -142,16 +98,168 @@ You will also likely need to add the following `.gitattributes` file to ensure t
|
|||||||
*.go text eol=lf
|
*.go text eol=lf
|
||||||
```
|
```
|
||||||
|
|
||||||
## Comments and Annotations
|
## Options
|
||||||
|
|
||||||
|
### `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).
|
||||||
|
|
||||||
|
### `annotations`
|
||||||
|
|
||||||
|
(optional)
|
||||||
|
|
||||||
|
To enable/disable GitHub Action annotations.
|
||||||
|
|
||||||
|
If disabled (`false`), the output format(s) will follow the golangci-lint configuration file (or CLI flags from `args`)
|
||||||
|
and use the same default as golangci-lint (i.e. `colored-line-number`).
|
||||||
|
|
||||||
|
https://golangci-lint.run/usage/configuration/#output-configuration
|
||||||
|
|
||||||
|
The default value is `true`.
|
||||||
|
|
||||||
|
```yml
|
||||||
|
uses: golangci/golangci-lint-action@v5
|
||||||
|
with:
|
||||||
|
annotations: false
|
||||||
|
# ...
|
||||||
|
```
|
||||||
|
|
||||||
|
### `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/).
|
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:
|
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 the 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.
|
To enable annotations, you need to add the `checks` permission to your action.
|
||||||
|
|
||||||
```yaml annotate
|
```yaml annotate
|
||||||
permissions:
|
permissions:
|
||||||
@ -159,7 +267,7 @@ permissions:
|
|||||||
contents: read
|
contents: read
|
||||||
# Optional: allow read access to pull request. Use with `only-new-issues` option.
|
# Optional: allow read access to pull request. Use with `only-new-issues` option.
|
||||||
pull-requests: read
|
pull-requests: read
|
||||||
# Optional: Allow write access to checks to allow the action to annotate code in the PR.
|
# Optional: allow write access to checks to allow the action to annotate code in the PR.
|
||||||
checks: write
|
checks: write
|
||||||
```
|
```
|
||||||
|
|
||||||
@ -167,9 +275,9 @@ permissions:
|
|||||||
|
|
||||||
The action was implemented with performance in mind:
|
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.
|
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:
|
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:
|
* in parallel:
|
||||||
@ -179,9 +287,10 @@ For example, in a repository of [golangci-lint](https://github.com/golangci/gola
|
|||||||
|
|
||||||
## Internals
|
## 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)
|
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.
|
||||||
@ -189,18 +298,22 @@ We support different platforms, such as `ubuntu`, `macos`, and `windows` with `x
|
|||||||
Inside our action, we perform 3 steps:
|
Inside our action, we perform 3 steps:
|
||||||
|
|
||||||
1. Setup environment running in parallel:
|
1. Setup environment running in parallel:
|
||||||
* restore [cache](https://github.com/actions/cache) of previous analyses
|
* 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`
|
2. Run `golangci-lint` with specified by user `args`
|
||||||
3. Save cache for later builds
|
3. Save cache for later builds
|
||||||
|
|
||||||
### Caching internals
|
### 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.
|
This scheme is basic and needs improvements. Pull requests and ideas are welcome.
|
||||||
|
|
||||||
|
33
action.yml
33
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."
|
description: "Official golangci-lint action with line-attached annotations for found issues, caching and parallel execution."
|
||||||
author: "golangci"
|
author: "golangci"
|
||||||
inputs:
|
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 `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.
|
When `install-mode` is `goinstall` the value can be v1.2.3, `latest`, or the hash of a commit.
|
||||||
required: false
|
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
|
required: false
|
||||||
working-directory:
|
working-directory:
|
||||||
description: "golangci-lint working directory, default is project root"
|
description: "golangci-lint working directory, default is project root"
|
||||||
@ -29,17 +30,23 @@ inputs:
|
|||||||
takes precedence over all other caching options.
|
takes precedence over all other caching options.
|
||||||
default: 'false'
|
default: 'false'
|
||||||
required: 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'
|
default: 'false'
|
||||||
required: false
|
required: false
|
||||||
skip-build-cache:
|
annotations:
|
||||||
description: "if set to true then the action doesn't cache or restore ~/.cache/go-build."
|
description: "To Enable/disable GitHub Action annotations"
|
||||||
default: 'false'
|
default: 'true'
|
||||||
required: 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
|
required: false
|
||||||
runs:
|
runs:
|
||||||
using: "node20"
|
using: "node20"
|
||||||
@ -47,4 +54,4 @@ runs:
|
|||||||
post: "dist/post_run/index.js"
|
post: "dist/post_run/index.js"
|
||||||
branding:
|
branding:
|
||||||
icon: "shield"
|
icon: "shield"
|
||||||
color: "yellow"
|
color: "white"
|
||||||
|
171
dist/post_run/index.js
generated
vendored
171
dist/post_run/index.js
generated
vendored
@ -88813,39 +88813,28 @@ const pathExists = async (path) => !!(await fs.promises.stat(path).catch(() => f
|
|||||||
const getLintCacheDir = () => {
|
const getLintCacheDir = () => {
|
||||||
return path_1.default.resolve(`${process.env.HOME}/.cache/golangci-lint`);
|
return path_1.default.resolve(`${process.env.HOME}/.cache/golangci-lint`);
|
||||||
};
|
};
|
||||||
const getCacheDirs = () => {
|
|
||||||
// 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_1.default.resolve(`${process.env.HOME}/.cache/go-build`));
|
|
||||||
}
|
|
||||||
if (skipPkgCache.toLowerCase() == "true") {
|
|
||||||
core.info(`Omitting ~/go/pkg from cache directories`);
|
|
||||||
}
|
|
||||||
else {
|
|
||||||
dirs.push(path_1.default.resolve(`${process.env.HOME}/go/pkg`));
|
|
||||||
}
|
|
||||||
return dirs;
|
|
||||||
};
|
|
||||||
const getIntervalKey = (invalidationIntervalDays) => {
|
const getIntervalKey = (invalidationIntervalDays) => {
|
||||||
const now = new Date();
|
const now = new Date();
|
||||||
|
if (invalidationIntervalDays <= 0) {
|
||||||
|
return `${now.getTime()}`;
|
||||||
|
}
|
||||||
const secondsSinceEpoch = now.getTime() / 1000;
|
const secondsSinceEpoch = now.getTime() / 1000;
|
||||||
const intervalNumber = Math.floor(secondsSinceEpoch / (invalidationIntervalDays * 86400));
|
const intervalNumber = Math.floor(secondsSinceEpoch / (invalidationIntervalDays * 86400));
|
||||||
return intervalNumber.toString();
|
return intervalNumber.toString();
|
||||||
};
|
};
|
||||||
async function buildCacheKeys() {
|
async function buildCacheKeys() {
|
||||||
const keys = [];
|
const keys = [];
|
||||||
// Periodically invalidate a cache because a new code being added.
|
// Cache by OS.
|
||||||
// TODO: configure it via inputs.
|
let cacheKey = `golangci-lint.cache-${process.env?.RUNNER_OS}-`;
|
||||||
let cacheKey = `golangci-lint.cache-${getIntervalKey(7)}-`;
|
|
||||||
keys.push(cacheKey);
|
|
||||||
// Get working directory from input
|
// Get working directory from input
|
||||||
const workingDirectory = core.getInput(`working-directory`);
|
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
|
// create path to go.mod prepending the workingDirectory if it exists
|
||||||
const goModPath = path_1.default.join(workingDirectory, `go.mod`);
|
const goModPath = path_1.default.join(workingDirectory, `go.mod`);
|
||||||
core.info(`Checking for go.mod: ${goModPath}`);
|
core.info(`Checking for go.mod: ${goModPath}`);
|
||||||
@ -88860,7 +88849,7 @@ async function buildCacheKeys() {
|
|||||||
return keys;
|
return keys;
|
||||||
}
|
}
|
||||||
async function restoreCache() {
|
async function restoreCache() {
|
||||||
if (core.getInput(`skip-cache`, { required: true }).trim() == "true")
|
if (core.getBooleanInput(`skip-cache`, { required: true }))
|
||||||
return;
|
return;
|
||||||
if (!utils.isValidEvent()) {
|
if (!utils.isValidEvent()) {
|
||||||
utils.logWarning(`Event Validation Error: The event type ${process.env[constants_1.Events.Key]} is not supported because it's not tied to a branch or tag ref.`);
|
utils.logWarning(`Event Validation Error: The event type ${process.env[constants_1.Events.Key]} is not supported because it's not tied to a branch or tag ref.`);
|
||||||
@ -88878,7 +88867,7 @@ async function restoreCache() {
|
|||||||
}
|
}
|
||||||
core.saveState(constants_1.State.CachePrimaryKey, primaryKey);
|
core.saveState(constants_1.State.CachePrimaryKey, primaryKey);
|
||||||
try {
|
try {
|
||||||
const cacheKey = await cache.restoreCache(getCacheDirs(), primaryKey, restoreKeys);
|
const cacheKey = await cache.restoreCache([getLintCacheDir()], primaryKey, restoreKeys);
|
||||||
if (!cacheKey) {
|
if (!cacheKey) {
|
||||||
core.info(`Cache not found for input keys: ${[primaryKey, ...restoreKeys].join(", ")}`);
|
core.info(`Cache not found for input keys: ${[primaryKey, ...restoreKeys].join(", ")}`);
|
||||||
return;
|
return;
|
||||||
@ -88898,7 +88887,9 @@ async function restoreCache() {
|
|||||||
}
|
}
|
||||||
exports.restoreCache = restoreCache;
|
exports.restoreCache = restoreCache;
|
||||||
async function saveCache() {
|
async function saveCache() {
|
||||||
if (core.getInput(`skip-cache`, { required: true }).trim() == "true")
|
if (core.getBooleanInput(`skip-cache`, { required: true }))
|
||||||
|
return;
|
||||||
|
if (core.getBooleanInput(`skip-save-cache`, { required: true }))
|
||||||
return;
|
return;
|
||||||
// Validate inputs, this can cause task failure
|
// Validate inputs, this can cause task failure
|
||||||
if (!utils.isValidEvent()) {
|
if (!utils.isValidEvent()) {
|
||||||
@ -88906,7 +88897,7 @@ async function saveCache() {
|
|||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
const startedAt = Date.now();
|
const startedAt = Date.now();
|
||||||
const cacheDirs = getCacheDirs();
|
const cacheDirs = [getLintCacheDir()];
|
||||||
const primaryKey = core.getState(constants_1.State.CachePrimaryKey);
|
const primaryKey = core.getState(constants_1.State.CachePrimaryKey);
|
||||||
if (!primaryKey) {
|
if (!primaryKey) {
|
||||||
utils.logWarning(`Error retrieving key from state.`);
|
utils.logWarning(`Error retrieving key from state.`);
|
||||||
@ -89163,26 +89154,36 @@ const version_1 = __nccwpck_require__(1946);
|
|||||||
const execShellCommand = (0, util_1.promisify)(child_process_1.exec);
|
const execShellCommand = (0, util_1.promisify)(child_process_1.exec);
|
||||||
const writeFile = (0, util_1.promisify)(fs.writeFile);
|
const writeFile = (0, util_1.promisify)(fs.writeFile);
|
||||||
const createTempDir = (0, util_1.promisify)(tmp_1.dir);
|
const createTempDir = (0, util_1.promisify)(tmp_1.dir);
|
||||||
|
function isOnlyNewIssues() {
|
||||||
|
return core.getBooleanInput(`only-new-issues`, { required: true });
|
||||||
|
}
|
||||||
async function prepareLint() {
|
async function prepareLint() {
|
||||||
const mode = core.getInput("install-mode").toLowerCase();
|
const mode = core.getInput("install-mode").toLowerCase();
|
||||||
const versionConfig = await (0, version_1.findLintVersion)(mode);
|
const versionConfig = await (0, version_1.findLintVersion)(mode);
|
||||||
return await (0, install_1.installLint)(versionConfig, mode);
|
return await (0, install_1.installLint)(versionConfig, mode);
|
||||||
}
|
}
|
||||||
async function fetchPatch() {
|
async function fetchPatch() {
|
||||||
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 ``;
|
return ``;
|
||||||
}
|
}
|
||||||
const ctx = github.context;
|
const ctx = github.context;
|
||||||
if (ctx.eventName !== `pull_request`) {
|
switch (ctx.eventName) {
|
||||||
core.info(`Not fetching patch for showing only new issues because it's not a pull request context: event name is ${ctx.eventName}`);
|
case `pull_request`:
|
||||||
return ``;
|
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) {
|
||||||
|
const pr = ctx.payload.pull_request;
|
||||||
|
if (!pr) {
|
||||||
core.warning(`No pull request in context`);
|
core.warning(`No pull request in context`);
|
||||||
return ``;
|
return ``;
|
||||||
}
|
}
|
||||||
@ -89192,7 +89193,7 @@ async function fetchPatch() {
|
|||||||
const patchResp = await octokit.rest.pulls.get({
|
const patchResp = await octokit.rest.pulls.get({
|
||||||
owner: ctx.repo.owner,
|
owner: ctx.repo.owner,
|
||||||
repo: ctx.repo.repo,
|
repo: ctx.repo.repo,
|
||||||
[`pull_number`]: pull.number,
|
[`pull_number`]: pr.number,
|
||||||
mediaType: {
|
mediaType: {
|
||||||
format: `diff`,
|
format: `diff`,
|
||||||
},
|
},
|
||||||
@ -89220,14 +89221,47 @@ async function fetchPatch() {
|
|||||||
return ``; // don't fail the action, but analyze without patch
|
return ``; // don't fail the action, but analyze without patch
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
async function fetchPushPatch(ctx) {
|
||||||
|
const octokit = github.getOctokit(core.getInput(`github-token`, { required: true }));
|
||||||
|
let patch;
|
||||||
|
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;
|
||||||
|
}
|
||||||
|
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, (0, diffUtils_1.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
|
||||||
|
}
|
||||||
|
}
|
||||||
async function prepareEnv() {
|
async function prepareEnv() {
|
||||||
const startedAt = Date.now();
|
const startedAt = Date.now();
|
||||||
// Prepare cache, lint and go in parallel.
|
// Prepare cache, lint and go in parallel.
|
||||||
await (0, cache_1.restoreCache)();
|
await (0, cache_1.restoreCache)();
|
||||||
const prepareLintPromise = prepareLint();
|
const lintPath = await prepareLint();
|
||||||
const patchPromise = fetchPatch();
|
const patchPath = await fetchPatch();
|
||||||
const lintPath = await prepareLintPromise;
|
|
||||||
const patchPath = await patchPromise;
|
|
||||||
core.info(`Prepared env in ${Date.now() - startedAt}ms`);
|
core.info(`Prepared env in ${Date.now() - startedAt}ms`);
|
||||||
return { lintPath, patchPath };
|
return { lintPath, patchPath };
|
||||||
}
|
}
|
||||||
@ -89256,26 +89290,47 @@ async function runLint(lintPath, patchPath) {
|
|||||||
.map(([key, value]) => [key.toLowerCase(), value ?? ""]);
|
.map(([key, value]) => [key.toLowerCase(), value ?? ""]);
|
||||||
const userArgsMap = new Map(userArgsList);
|
const userArgsMap = new Map(userArgsList);
|
||||||
const userArgNames = new Set(userArgsList.map(([key]) => key));
|
const userArgNames = new Set(userArgsList.map(([key]) => key));
|
||||||
const formats = (userArgsMap.get("out-format") || "")
|
const annotations = core.getBooleanInput(`annotations`);
|
||||||
.trim()
|
if (annotations) {
|
||||||
.split(",")
|
const formats = (userArgsMap.get("out-format") || "")
|
||||||
.filter((f) => f.length > 0)
|
.trim()
|
||||||
.filter((f) => !f.startsWith(`github-actions`))
|
.split(",")
|
||||||
.concat("github-actions")
|
.filter((f) => f.length > 0)
|
||||||
.join(",");
|
.filter((f) => !f.startsWith(`github-actions`))
|
||||||
addedArgs.push(`--out-format=${formats}`);
|
.concat("github-actions")
|
||||||
userArgs = userArgs.replace(/--out-format=\S*/gi, "").trim();
|
.join(",");
|
||||||
if (patchPath) {
|
addedArgs.push(`--out-format=${formats}`);
|
||||||
|
userArgs = userArgs.replace(/--out-format=\S*/gi, "").trim();
|
||||||
|
}
|
||||||
|
if (isOnlyNewIssues()) {
|
||||||
if (userArgNames.has(`new`) || userArgNames.has(`new-from-rev`) || userArgNames.has(`new-from-patch`)) {
|
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`);
|
throw new Error(`please, don't specify manually --new* args when requesting only new issues`);
|
||||||
}
|
}
|
||||||
addedArgs.push(`--new-from-patch=${patchPath}`);
|
const ctx = github.context;
|
||||||
// Override config values.
|
core.info(`only new issues on ${ctx.eventName}: ${patchPath}`);
|
||||||
addedArgs.push(`--new=false`);
|
switch (ctx.eventName) {
|
||||||
addedArgs.push(`--new-from-rev=`);
|
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 workingDirectory = core.getInput(`working-directory`);
|
|
||||||
const cmdArgs = {};
|
const cmdArgs = {};
|
||||||
|
const workingDirectory = core.getInput(`working-directory`);
|
||||||
if (workingDirectory) {
|
if (workingDirectory) {
|
||||||
if (!fs.existsSync(workingDirectory) || !fs.lstatSync(workingDirectory).isDirectory()) {
|
if (!fs.existsSync(workingDirectory) || !fs.lstatSync(workingDirectory).isDirectory()) {
|
||||||
throw new Error(`working-directory (${workingDirectory}) was not a path`);
|
throw new Error(`working-directory (${workingDirectory}) was not a path`);
|
||||||
@ -89286,7 +89341,7 @@ async function runLint(lintPath, patchPath) {
|
|||||||
cmdArgs.cwd = path.resolve(workingDirectory);
|
cmdArgs.cwd = path.resolve(workingDirectory);
|
||||||
}
|
}
|
||||||
const cmd = `${lintPath} run ${addedArgs.join(` `)} ${userArgs}`.trimEnd();
|
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();
|
const startedAt = Date.now();
|
||||||
try {
|
try {
|
||||||
const res = await execShellCommand(cmd, cmdArgs);
|
const res = await execShellCommand(cmd, cmdArgs);
|
||||||
|
171
dist/run/index.js
generated
vendored
171
dist/run/index.js
generated
vendored
@ -88813,39 +88813,28 @@ const pathExists = async (path) => !!(await fs.promises.stat(path).catch(() => f
|
|||||||
const getLintCacheDir = () => {
|
const getLintCacheDir = () => {
|
||||||
return path_1.default.resolve(`${process.env.HOME}/.cache/golangci-lint`);
|
return path_1.default.resolve(`${process.env.HOME}/.cache/golangci-lint`);
|
||||||
};
|
};
|
||||||
const getCacheDirs = () => {
|
|
||||||
// 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_1.default.resolve(`${process.env.HOME}/.cache/go-build`));
|
|
||||||
}
|
|
||||||
if (skipPkgCache.toLowerCase() == "true") {
|
|
||||||
core.info(`Omitting ~/go/pkg from cache directories`);
|
|
||||||
}
|
|
||||||
else {
|
|
||||||
dirs.push(path_1.default.resolve(`${process.env.HOME}/go/pkg`));
|
|
||||||
}
|
|
||||||
return dirs;
|
|
||||||
};
|
|
||||||
const getIntervalKey = (invalidationIntervalDays) => {
|
const getIntervalKey = (invalidationIntervalDays) => {
|
||||||
const now = new Date();
|
const now = new Date();
|
||||||
|
if (invalidationIntervalDays <= 0) {
|
||||||
|
return `${now.getTime()}`;
|
||||||
|
}
|
||||||
const secondsSinceEpoch = now.getTime() / 1000;
|
const secondsSinceEpoch = now.getTime() / 1000;
|
||||||
const intervalNumber = Math.floor(secondsSinceEpoch / (invalidationIntervalDays * 86400));
|
const intervalNumber = Math.floor(secondsSinceEpoch / (invalidationIntervalDays * 86400));
|
||||||
return intervalNumber.toString();
|
return intervalNumber.toString();
|
||||||
};
|
};
|
||||||
async function buildCacheKeys() {
|
async function buildCacheKeys() {
|
||||||
const keys = [];
|
const keys = [];
|
||||||
// Periodically invalidate a cache because a new code being added.
|
// Cache by OS.
|
||||||
// TODO: configure it via inputs.
|
let cacheKey = `golangci-lint.cache-${process.env?.RUNNER_OS}-`;
|
||||||
let cacheKey = `golangci-lint.cache-${getIntervalKey(7)}-`;
|
|
||||||
keys.push(cacheKey);
|
|
||||||
// Get working directory from input
|
// Get working directory from input
|
||||||
const workingDirectory = core.getInput(`working-directory`);
|
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
|
// create path to go.mod prepending the workingDirectory if it exists
|
||||||
const goModPath = path_1.default.join(workingDirectory, `go.mod`);
|
const goModPath = path_1.default.join(workingDirectory, `go.mod`);
|
||||||
core.info(`Checking for go.mod: ${goModPath}`);
|
core.info(`Checking for go.mod: ${goModPath}`);
|
||||||
@ -88860,7 +88849,7 @@ async function buildCacheKeys() {
|
|||||||
return keys;
|
return keys;
|
||||||
}
|
}
|
||||||
async function restoreCache() {
|
async function restoreCache() {
|
||||||
if (core.getInput(`skip-cache`, { required: true }).trim() == "true")
|
if (core.getBooleanInput(`skip-cache`, { required: true }))
|
||||||
return;
|
return;
|
||||||
if (!utils.isValidEvent()) {
|
if (!utils.isValidEvent()) {
|
||||||
utils.logWarning(`Event Validation Error: The event type ${process.env[constants_1.Events.Key]} is not supported because it's not tied to a branch or tag ref.`);
|
utils.logWarning(`Event Validation Error: The event type ${process.env[constants_1.Events.Key]} is not supported because it's not tied to a branch or tag ref.`);
|
||||||
@ -88878,7 +88867,7 @@ async function restoreCache() {
|
|||||||
}
|
}
|
||||||
core.saveState(constants_1.State.CachePrimaryKey, primaryKey);
|
core.saveState(constants_1.State.CachePrimaryKey, primaryKey);
|
||||||
try {
|
try {
|
||||||
const cacheKey = await cache.restoreCache(getCacheDirs(), primaryKey, restoreKeys);
|
const cacheKey = await cache.restoreCache([getLintCacheDir()], primaryKey, restoreKeys);
|
||||||
if (!cacheKey) {
|
if (!cacheKey) {
|
||||||
core.info(`Cache not found for input keys: ${[primaryKey, ...restoreKeys].join(", ")}`);
|
core.info(`Cache not found for input keys: ${[primaryKey, ...restoreKeys].join(", ")}`);
|
||||||
return;
|
return;
|
||||||
@ -88898,7 +88887,9 @@ async function restoreCache() {
|
|||||||
}
|
}
|
||||||
exports.restoreCache = restoreCache;
|
exports.restoreCache = restoreCache;
|
||||||
async function saveCache() {
|
async function saveCache() {
|
||||||
if (core.getInput(`skip-cache`, { required: true }).trim() == "true")
|
if (core.getBooleanInput(`skip-cache`, { required: true }))
|
||||||
|
return;
|
||||||
|
if (core.getBooleanInput(`skip-save-cache`, { required: true }))
|
||||||
return;
|
return;
|
||||||
// Validate inputs, this can cause task failure
|
// Validate inputs, this can cause task failure
|
||||||
if (!utils.isValidEvent()) {
|
if (!utils.isValidEvent()) {
|
||||||
@ -88906,7 +88897,7 @@ async function saveCache() {
|
|||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
const startedAt = Date.now();
|
const startedAt = Date.now();
|
||||||
const cacheDirs = getCacheDirs();
|
const cacheDirs = [getLintCacheDir()];
|
||||||
const primaryKey = core.getState(constants_1.State.CachePrimaryKey);
|
const primaryKey = core.getState(constants_1.State.CachePrimaryKey);
|
||||||
if (!primaryKey) {
|
if (!primaryKey) {
|
||||||
utils.logWarning(`Error retrieving key from state.`);
|
utils.logWarning(`Error retrieving key from state.`);
|
||||||
@ -89163,26 +89154,36 @@ const version_1 = __nccwpck_require__(1946);
|
|||||||
const execShellCommand = (0, util_1.promisify)(child_process_1.exec);
|
const execShellCommand = (0, util_1.promisify)(child_process_1.exec);
|
||||||
const writeFile = (0, util_1.promisify)(fs.writeFile);
|
const writeFile = (0, util_1.promisify)(fs.writeFile);
|
||||||
const createTempDir = (0, util_1.promisify)(tmp_1.dir);
|
const createTempDir = (0, util_1.promisify)(tmp_1.dir);
|
||||||
|
function isOnlyNewIssues() {
|
||||||
|
return core.getBooleanInput(`only-new-issues`, { required: true });
|
||||||
|
}
|
||||||
async function prepareLint() {
|
async function prepareLint() {
|
||||||
const mode = core.getInput("install-mode").toLowerCase();
|
const mode = core.getInput("install-mode").toLowerCase();
|
||||||
const versionConfig = await (0, version_1.findLintVersion)(mode);
|
const versionConfig = await (0, version_1.findLintVersion)(mode);
|
||||||
return await (0, install_1.installLint)(versionConfig, mode);
|
return await (0, install_1.installLint)(versionConfig, mode);
|
||||||
}
|
}
|
||||||
async function fetchPatch() {
|
async function fetchPatch() {
|
||||||
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 ``;
|
return ``;
|
||||||
}
|
}
|
||||||
const ctx = github.context;
|
const ctx = github.context;
|
||||||
if (ctx.eventName !== `pull_request`) {
|
switch (ctx.eventName) {
|
||||||
core.info(`Not fetching patch for showing only new issues because it's not a pull request context: event name is ${ctx.eventName}`);
|
case `pull_request`:
|
||||||
return ``;
|
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) {
|
||||||
|
const pr = ctx.payload.pull_request;
|
||||||
|
if (!pr) {
|
||||||
core.warning(`No pull request in context`);
|
core.warning(`No pull request in context`);
|
||||||
return ``;
|
return ``;
|
||||||
}
|
}
|
||||||
@ -89192,7 +89193,7 @@ async function fetchPatch() {
|
|||||||
const patchResp = await octokit.rest.pulls.get({
|
const patchResp = await octokit.rest.pulls.get({
|
||||||
owner: ctx.repo.owner,
|
owner: ctx.repo.owner,
|
||||||
repo: ctx.repo.repo,
|
repo: ctx.repo.repo,
|
||||||
[`pull_number`]: pull.number,
|
[`pull_number`]: pr.number,
|
||||||
mediaType: {
|
mediaType: {
|
||||||
format: `diff`,
|
format: `diff`,
|
||||||
},
|
},
|
||||||
@ -89220,14 +89221,47 @@ async function fetchPatch() {
|
|||||||
return ``; // don't fail the action, but analyze without patch
|
return ``; // don't fail the action, but analyze without patch
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
async function fetchPushPatch(ctx) {
|
||||||
|
const octokit = github.getOctokit(core.getInput(`github-token`, { required: true }));
|
||||||
|
let patch;
|
||||||
|
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;
|
||||||
|
}
|
||||||
|
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, (0, diffUtils_1.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
|
||||||
|
}
|
||||||
|
}
|
||||||
async function prepareEnv() {
|
async function prepareEnv() {
|
||||||
const startedAt = Date.now();
|
const startedAt = Date.now();
|
||||||
// Prepare cache, lint and go in parallel.
|
// Prepare cache, lint and go in parallel.
|
||||||
await (0, cache_1.restoreCache)();
|
await (0, cache_1.restoreCache)();
|
||||||
const prepareLintPromise = prepareLint();
|
const lintPath = await prepareLint();
|
||||||
const patchPromise = fetchPatch();
|
const patchPath = await fetchPatch();
|
||||||
const lintPath = await prepareLintPromise;
|
|
||||||
const patchPath = await patchPromise;
|
|
||||||
core.info(`Prepared env in ${Date.now() - startedAt}ms`);
|
core.info(`Prepared env in ${Date.now() - startedAt}ms`);
|
||||||
return { lintPath, patchPath };
|
return { lintPath, patchPath };
|
||||||
}
|
}
|
||||||
@ -89256,26 +89290,47 @@ async function runLint(lintPath, patchPath) {
|
|||||||
.map(([key, value]) => [key.toLowerCase(), value ?? ""]);
|
.map(([key, value]) => [key.toLowerCase(), value ?? ""]);
|
||||||
const userArgsMap = new Map(userArgsList);
|
const userArgsMap = new Map(userArgsList);
|
||||||
const userArgNames = new Set(userArgsList.map(([key]) => key));
|
const userArgNames = new Set(userArgsList.map(([key]) => key));
|
||||||
const formats = (userArgsMap.get("out-format") || "")
|
const annotations = core.getBooleanInput(`annotations`);
|
||||||
.trim()
|
if (annotations) {
|
||||||
.split(",")
|
const formats = (userArgsMap.get("out-format") || "")
|
||||||
.filter((f) => f.length > 0)
|
.trim()
|
||||||
.filter((f) => !f.startsWith(`github-actions`))
|
.split(",")
|
||||||
.concat("github-actions")
|
.filter((f) => f.length > 0)
|
||||||
.join(",");
|
.filter((f) => !f.startsWith(`github-actions`))
|
||||||
addedArgs.push(`--out-format=${formats}`);
|
.concat("github-actions")
|
||||||
userArgs = userArgs.replace(/--out-format=\S*/gi, "").trim();
|
.join(",");
|
||||||
if (patchPath) {
|
addedArgs.push(`--out-format=${formats}`);
|
||||||
|
userArgs = userArgs.replace(/--out-format=\S*/gi, "").trim();
|
||||||
|
}
|
||||||
|
if (isOnlyNewIssues()) {
|
||||||
if (userArgNames.has(`new`) || userArgNames.has(`new-from-rev`) || userArgNames.has(`new-from-patch`)) {
|
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`);
|
throw new Error(`please, don't specify manually --new* args when requesting only new issues`);
|
||||||
}
|
}
|
||||||
addedArgs.push(`--new-from-patch=${patchPath}`);
|
const ctx = github.context;
|
||||||
// Override config values.
|
core.info(`only new issues on ${ctx.eventName}: ${patchPath}`);
|
||||||
addedArgs.push(`--new=false`);
|
switch (ctx.eventName) {
|
||||||
addedArgs.push(`--new-from-rev=`);
|
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 workingDirectory = core.getInput(`working-directory`);
|
|
||||||
const cmdArgs = {};
|
const cmdArgs = {};
|
||||||
|
const workingDirectory = core.getInput(`working-directory`);
|
||||||
if (workingDirectory) {
|
if (workingDirectory) {
|
||||||
if (!fs.existsSync(workingDirectory) || !fs.lstatSync(workingDirectory).isDirectory()) {
|
if (!fs.existsSync(workingDirectory) || !fs.lstatSync(workingDirectory).isDirectory()) {
|
||||||
throw new Error(`working-directory (${workingDirectory}) was not a path`);
|
throw new Error(`working-directory (${workingDirectory}) was not a path`);
|
||||||
@ -89286,7 +89341,7 @@ async function runLint(lintPath, patchPath) {
|
|||||||
cmdArgs.cwd = path.resolve(workingDirectory);
|
cmdArgs.cwd = path.resolve(workingDirectory);
|
||||||
}
|
}
|
||||||
const cmd = `${lintPath} run ${addedArgs.join(` `)} ${userArgs}`.trimEnd();
|
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();
|
const startedAt = Date.now();
|
||||||
try {
|
try {
|
||||||
const res = await execShellCommand(cmd, cmdArgs);
|
const res = await execShellCommand(cmd, cmdArgs);
|
||||||
|
172
package-lock.json
generated
172
package-lock.json
generated
@ -21,8 +21,8 @@
|
|||||||
"tmp": "^0.2.3"
|
"tmp": "^0.2.3"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@typescript-eslint/eslint-plugin": "^7.7.0",
|
"@typescript-eslint/eslint-plugin": "^7.7.1",
|
||||||
"@typescript-eslint/parser": "^7.7.0",
|
"@typescript-eslint/parser": "^7.7.1",
|
||||||
"@vercel/ncc": "^0.38.1",
|
"@vercel/ncc": "^0.38.1",
|
||||||
"eslint": "^8.57.0",
|
"eslint": "^8.57.0",
|
||||||
"eslint-config-prettier": "^9.1.0",
|
"eslint-config-prettier": "^9.1.0",
|
||||||
@ -691,16 +691,16 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"node_modules/@typescript-eslint/eslint-plugin": {
|
"node_modules/@typescript-eslint/eslint-plugin": {
|
||||||
"version": "7.7.0",
|
"version": "7.7.1",
|
||||||
"resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-7.7.0.tgz",
|
"resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-7.7.1.tgz",
|
||||||
"integrity": "sha512-GJWR0YnfrKnsRoluVO3PRb9r5aMZriiMMM/RHj5nnTrBy1/wIgk76XCtCKcnXGjpZQJQRFtGV9/0JJ6n30uwpQ==",
|
"integrity": "sha512-KwfdWXJBOviaBVhxO3p5TJiLpNuh2iyXyjmWN0f1nU87pwyvfS0EmjC6ukQVYVFJd/K1+0NWGPDXiyEyQorn0Q==",
|
||||||
"dev": true,
|
"dev": true,
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@eslint-community/regexpp": "^4.10.0",
|
"@eslint-community/regexpp": "^4.10.0",
|
||||||
"@typescript-eslint/scope-manager": "7.7.0",
|
"@typescript-eslint/scope-manager": "7.7.1",
|
||||||
"@typescript-eslint/type-utils": "7.7.0",
|
"@typescript-eslint/type-utils": "7.7.1",
|
||||||
"@typescript-eslint/utils": "7.7.0",
|
"@typescript-eslint/utils": "7.7.1",
|
||||||
"@typescript-eslint/visitor-keys": "7.7.0",
|
"@typescript-eslint/visitor-keys": "7.7.1",
|
||||||
"debug": "^4.3.4",
|
"debug": "^4.3.4",
|
||||||
"graphemer": "^1.4.0",
|
"graphemer": "^1.4.0",
|
||||||
"ignore": "^5.3.1",
|
"ignore": "^5.3.1",
|
||||||
@ -741,15 +741,15 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"node_modules/@typescript-eslint/parser": {
|
"node_modules/@typescript-eslint/parser": {
|
||||||
"version": "7.7.0",
|
"version": "7.7.1",
|
||||||
"resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-7.7.0.tgz",
|
"resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-7.7.1.tgz",
|
||||||
"integrity": "sha512-fNcDm3wSwVM8QYL4HKVBggdIPAy9Q41vcvC/GtDobw3c4ndVT3K6cqudUmjHPw8EAp4ufax0o58/xvWaP2FmTg==",
|
"integrity": "sha512-vmPzBOOtz48F6JAGVS/kZYk4EkXao6iGrD838sp1w3NQQC0W8ry/q641KU4PrG7AKNAf56NOcR8GOpH8l9FPCw==",
|
||||||
"dev": true,
|
"dev": true,
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@typescript-eslint/scope-manager": "7.7.0",
|
"@typescript-eslint/scope-manager": "7.7.1",
|
||||||
"@typescript-eslint/types": "7.7.0",
|
"@typescript-eslint/types": "7.7.1",
|
||||||
"@typescript-eslint/typescript-estree": "7.7.0",
|
"@typescript-eslint/typescript-estree": "7.7.1",
|
||||||
"@typescript-eslint/visitor-keys": "7.7.0",
|
"@typescript-eslint/visitor-keys": "7.7.1",
|
||||||
"debug": "^4.3.4"
|
"debug": "^4.3.4"
|
||||||
},
|
},
|
||||||
"engines": {
|
"engines": {
|
||||||
@ -769,13 +769,13 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"node_modules/@typescript-eslint/scope-manager": {
|
"node_modules/@typescript-eslint/scope-manager": {
|
||||||
"version": "7.7.0",
|
"version": "7.7.1",
|
||||||
"resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-7.7.0.tgz",
|
"resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-7.7.1.tgz",
|
||||||
"integrity": "sha512-/8INDn0YLInbe9Wt7dK4cXLDYp0fNHP5xKLHvZl3mOT5X17rK/YShXaiNmorl+/U4VKCVIjJnx4Ri5b0y+HClw==",
|
"integrity": "sha512-PytBif2SF+9SpEUKynYn5g1RHFddJUcyynGpztX3l/ik7KmZEv19WCMhUBkHXPU9es/VWGD3/zg3wg90+Dh2rA==",
|
||||||
"dev": true,
|
"dev": true,
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@typescript-eslint/types": "7.7.0",
|
"@typescript-eslint/types": "7.7.1",
|
||||||
"@typescript-eslint/visitor-keys": "7.7.0"
|
"@typescript-eslint/visitor-keys": "7.7.1"
|
||||||
},
|
},
|
||||||
"engines": {
|
"engines": {
|
||||||
"node": "^18.18.0 || >=20.0.0"
|
"node": "^18.18.0 || >=20.0.0"
|
||||||
@ -786,13 +786,13 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"node_modules/@typescript-eslint/type-utils": {
|
"node_modules/@typescript-eslint/type-utils": {
|
||||||
"version": "7.7.0",
|
"version": "7.7.1",
|
||||||
"resolved": "https://registry.npmjs.org/@typescript-eslint/type-utils/-/type-utils-7.7.0.tgz",
|
"resolved": "https://registry.npmjs.org/@typescript-eslint/type-utils/-/type-utils-7.7.1.tgz",
|
||||||
"integrity": "sha512-bOp3ejoRYrhAlnT/bozNQi3nio9tIgv3U5C0mVDdZC7cpcQEDZXvq8inrHYghLVwuNABRqrMW5tzAv88Vy77Sg==",
|
"integrity": "sha512-ZksJLW3WF7o75zaBPScdW1Gbkwhd/lyeXGf1kQCxJaOeITscoSl0MjynVvCzuV5boUz/3fOI06Lz8La55mu29Q==",
|
||||||
"dev": true,
|
"dev": true,
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@typescript-eslint/typescript-estree": "7.7.0",
|
"@typescript-eslint/typescript-estree": "7.7.1",
|
||||||
"@typescript-eslint/utils": "7.7.0",
|
"@typescript-eslint/utils": "7.7.1",
|
||||||
"debug": "^4.3.4",
|
"debug": "^4.3.4",
|
||||||
"ts-api-utils": "^1.3.0"
|
"ts-api-utils": "^1.3.0"
|
||||||
},
|
},
|
||||||
@ -813,9 +813,9 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"node_modules/@typescript-eslint/types": {
|
"node_modules/@typescript-eslint/types": {
|
||||||
"version": "7.7.0",
|
"version": "7.7.1",
|
||||||
"resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-7.7.0.tgz",
|
"resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-7.7.1.tgz",
|
||||||
"integrity": "sha512-G01YPZ1Bd2hn+KPpIbrAhEWOn5lQBrjxkzHkWvP6NucMXFtfXoevK82hzQdpfuQYuhkvFDeQYbzXCjR1z9Z03w==",
|
"integrity": "sha512-AmPmnGW1ZLTpWa+/2omPrPfR7BcbUU4oha5VIbSbS1a1Tv966bklvLNXxp3mrbc+P2j4MNOTfDffNsk4o0c6/w==",
|
||||||
"dev": true,
|
"dev": true,
|
||||||
"engines": {
|
"engines": {
|
||||||
"node": "^18.18.0 || >=20.0.0"
|
"node": "^18.18.0 || >=20.0.0"
|
||||||
@ -826,13 +826,13 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"node_modules/@typescript-eslint/typescript-estree": {
|
"node_modules/@typescript-eslint/typescript-estree": {
|
||||||
"version": "7.7.0",
|
"version": "7.7.1",
|
||||||
"resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-7.7.0.tgz",
|
"resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-7.7.1.tgz",
|
||||||
"integrity": "sha512-8p71HQPE6CbxIBy2kWHqM1KGrC07pk6RJn40n0DSc6bMOBBREZxSDJ+BmRzc8B5OdaMh1ty3mkuWRg4sCFiDQQ==",
|
"integrity": "sha512-CXe0JHCXru8Fa36dteXqmH2YxngKJjkQLjxzoj6LYwzZ7qZvgsLSc+eqItCrqIop8Vl2UKoAi0StVWu97FQZIQ==",
|
||||||
"dev": true,
|
"dev": true,
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@typescript-eslint/types": "7.7.0",
|
"@typescript-eslint/types": "7.7.1",
|
||||||
"@typescript-eslint/visitor-keys": "7.7.0",
|
"@typescript-eslint/visitor-keys": "7.7.1",
|
||||||
"debug": "^4.3.4",
|
"debug": "^4.3.4",
|
||||||
"globby": "^11.1.0",
|
"globby": "^11.1.0",
|
||||||
"is-glob": "^4.0.3",
|
"is-glob": "^4.0.3",
|
||||||
@ -893,17 +893,17 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"node_modules/@typescript-eslint/utils": {
|
"node_modules/@typescript-eslint/utils": {
|
||||||
"version": "7.7.0",
|
"version": "7.7.1",
|
||||||
"resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-7.7.0.tgz",
|
"resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-7.7.1.tgz",
|
||||||
"integrity": "sha512-LKGAXMPQs8U/zMRFXDZOzmMKgFv3COlxUQ+2NMPhbqgVm6R1w+nU1i4836Pmxu9jZAuIeyySNrN/6Rc657ggig==",
|
"integrity": "sha512-QUvBxPEaBXf41ZBbaidKICgVL8Hin0p6prQDu6bbetWo39BKbWJxRsErOzMNT1rXvTll+J7ChrbmMCXM9rsvOQ==",
|
||||||
"dev": true,
|
"dev": true,
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@eslint-community/eslint-utils": "^4.4.0",
|
"@eslint-community/eslint-utils": "^4.4.0",
|
||||||
"@types/json-schema": "^7.0.15",
|
"@types/json-schema": "^7.0.15",
|
||||||
"@types/semver": "^7.5.8",
|
"@types/semver": "^7.5.8",
|
||||||
"@typescript-eslint/scope-manager": "7.7.0",
|
"@typescript-eslint/scope-manager": "7.7.1",
|
||||||
"@typescript-eslint/types": "7.7.0",
|
"@typescript-eslint/types": "7.7.1",
|
||||||
"@typescript-eslint/typescript-estree": "7.7.0",
|
"@typescript-eslint/typescript-estree": "7.7.1",
|
||||||
"semver": "^7.6.0"
|
"semver": "^7.6.0"
|
||||||
},
|
},
|
||||||
"engines": {
|
"engines": {
|
||||||
@ -933,12 +933,12 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"node_modules/@typescript-eslint/visitor-keys": {
|
"node_modules/@typescript-eslint/visitor-keys": {
|
||||||
"version": "7.7.0",
|
"version": "7.7.1",
|
||||||
"resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-7.7.0.tgz",
|
"resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-7.7.1.tgz",
|
||||||
"integrity": "sha512-h0WHOj8MhdhY8YWkzIF30R379y0NqyOHExI9N9KCzvmu05EgG4FumeYa3ccfKUSphyWkWQE1ybVrgz/Pbam6YA==",
|
"integrity": "sha512-gBL3Eq25uADw1LQ9kVpf3hRM+DWzs0uZknHYK3hq4jcTPqVCClHGDnB6UUUV2SFeBeA4KWHWbbLqmbGcZ4FYbw==",
|
||||||
"dev": true,
|
"dev": true,
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@typescript-eslint/types": "7.7.0",
|
"@typescript-eslint/types": "7.7.1",
|
||||||
"eslint-visitor-keys": "^3.4.3"
|
"eslint-visitor-keys": "^3.4.3"
|
||||||
},
|
},
|
||||||
"engines": {
|
"engines": {
|
||||||
@ -4610,16 +4610,16 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"@typescript-eslint/eslint-plugin": {
|
"@typescript-eslint/eslint-plugin": {
|
||||||
"version": "7.7.0",
|
"version": "7.7.1",
|
||||||
"resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-7.7.0.tgz",
|
"resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-7.7.1.tgz",
|
||||||
"integrity": "sha512-GJWR0YnfrKnsRoluVO3PRb9r5aMZriiMMM/RHj5nnTrBy1/wIgk76XCtCKcnXGjpZQJQRFtGV9/0JJ6n30uwpQ==",
|
"integrity": "sha512-KwfdWXJBOviaBVhxO3p5TJiLpNuh2iyXyjmWN0f1nU87pwyvfS0EmjC6ukQVYVFJd/K1+0NWGPDXiyEyQorn0Q==",
|
||||||
"dev": true,
|
"dev": true,
|
||||||
"requires": {
|
"requires": {
|
||||||
"@eslint-community/regexpp": "^4.10.0",
|
"@eslint-community/regexpp": "^4.10.0",
|
||||||
"@typescript-eslint/scope-manager": "7.7.0",
|
"@typescript-eslint/scope-manager": "7.7.1",
|
||||||
"@typescript-eslint/type-utils": "7.7.0",
|
"@typescript-eslint/type-utils": "7.7.1",
|
||||||
"@typescript-eslint/utils": "7.7.0",
|
"@typescript-eslint/utils": "7.7.1",
|
||||||
"@typescript-eslint/visitor-keys": "7.7.0",
|
"@typescript-eslint/visitor-keys": "7.7.1",
|
||||||
"debug": "^4.3.4",
|
"debug": "^4.3.4",
|
||||||
"graphemer": "^1.4.0",
|
"graphemer": "^1.4.0",
|
||||||
"ignore": "^5.3.1",
|
"ignore": "^5.3.1",
|
||||||
@ -4640,54 +4640,54 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"@typescript-eslint/parser": {
|
"@typescript-eslint/parser": {
|
||||||
"version": "7.7.0",
|
"version": "7.7.1",
|
||||||
"resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-7.7.0.tgz",
|
"resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-7.7.1.tgz",
|
||||||
"integrity": "sha512-fNcDm3wSwVM8QYL4HKVBggdIPAy9Q41vcvC/GtDobw3c4ndVT3K6cqudUmjHPw8EAp4ufax0o58/xvWaP2FmTg==",
|
"integrity": "sha512-vmPzBOOtz48F6JAGVS/kZYk4EkXao6iGrD838sp1w3NQQC0W8ry/q641KU4PrG7AKNAf56NOcR8GOpH8l9FPCw==",
|
||||||
"dev": true,
|
"dev": true,
|
||||||
"requires": {
|
"requires": {
|
||||||
"@typescript-eslint/scope-manager": "7.7.0",
|
"@typescript-eslint/scope-manager": "7.7.1",
|
||||||
"@typescript-eslint/types": "7.7.0",
|
"@typescript-eslint/types": "7.7.1",
|
||||||
"@typescript-eslint/typescript-estree": "7.7.0",
|
"@typescript-eslint/typescript-estree": "7.7.1",
|
||||||
"@typescript-eslint/visitor-keys": "7.7.0",
|
"@typescript-eslint/visitor-keys": "7.7.1",
|
||||||
"debug": "^4.3.4"
|
"debug": "^4.3.4"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"@typescript-eslint/scope-manager": {
|
"@typescript-eslint/scope-manager": {
|
||||||
"version": "7.7.0",
|
"version": "7.7.1",
|
||||||
"resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-7.7.0.tgz",
|
"resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-7.7.1.tgz",
|
||||||
"integrity": "sha512-/8INDn0YLInbe9Wt7dK4cXLDYp0fNHP5xKLHvZl3mOT5X17rK/YShXaiNmorl+/U4VKCVIjJnx4Ri5b0y+HClw==",
|
"integrity": "sha512-PytBif2SF+9SpEUKynYn5g1RHFddJUcyynGpztX3l/ik7KmZEv19WCMhUBkHXPU9es/VWGD3/zg3wg90+Dh2rA==",
|
||||||
"dev": true,
|
"dev": true,
|
||||||
"requires": {
|
"requires": {
|
||||||
"@typescript-eslint/types": "7.7.0",
|
"@typescript-eslint/types": "7.7.1",
|
||||||
"@typescript-eslint/visitor-keys": "7.7.0"
|
"@typescript-eslint/visitor-keys": "7.7.1"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"@typescript-eslint/type-utils": {
|
"@typescript-eslint/type-utils": {
|
||||||
"version": "7.7.0",
|
"version": "7.7.1",
|
||||||
"resolved": "https://registry.npmjs.org/@typescript-eslint/type-utils/-/type-utils-7.7.0.tgz",
|
"resolved": "https://registry.npmjs.org/@typescript-eslint/type-utils/-/type-utils-7.7.1.tgz",
|
||||||
"integrity": "sha512-bOp3ejoRYrhAlnT/bozNQi3nio9tIgv3U5C0mVDdZC7cpcQEDZXvq8inrHYghLVwuNABRqrMW5tzAv88Vy77Sg==",
|
"integrity": "sha512-ZksJLW3WF7o75zaBPScdW1Gbkwhd/lyeXGf1kQCxJaOeITscoSl0MjynVvCzuV5boUz/3fOI06Lz8La55mu29Q==",
|
||||||
"dev": true,
|
"dev": true,
|
||||||
"requires": {
|
"requires": {
|
||||||
"@typescript-eslint/typescript-estree": "7.7.0",
|
"@typescript-eslint/typescript-estree": "7.7.1",
|
||||||
"@typescript-eslint/utils": "7.7.0",
|
"@typescript-eslint/utils": "7.7.1",
|
||||||
"debug": "^4.3.4",
|
"debug": "^4.3.4",
|
||||||
"ts-api-utils": "^1.3.0"
|
"ts-api-utils": "^1.3.0"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"@typescript-eslint/types": {
|
"@typescript-eslint/types": {
|
||||||
"version": "7.7.0",
|
"version": "7.7.1",
|
||||||
"resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-7.7.0.tgz",
|
"resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-7.7.1.tgz",
|
||||||
"integrity": "sha512-G01YPZ1Bd2hn+KPpIbrAhEWOn5lQBrjxkzHkWvP6NucMXFtfXoevK82hzQdpfuQYuhkvFDeQYbzXCjR1z9Z03w==",
|
"integrity": "sha512-AmPmnGW1ZLTpWa+/2omPrPfR7BcbUU4oha5VIbSbS1a1Tv966bklvLNXxp3mrbc+P2j4MNOTfDffNsk4o0c6/w==",
|
||||||
"dev": true
|
"dev": true
|
||||||
},
|
},
|
||||||
"@typescript-eslint/typescript-estree": {
|
"@typescript-eslint/typescript-estree": {
|
||||||
"version": "7.7.0",
|
"version": "7.7.1",
|
||||||
"resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-7.7.0.tgz",
|
"resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-7.7.1.tgz",
|
||||||
"integrity": "sha512-8p71HQPE6CbxIBy2kWHqM1KGrC07pk6RJn40n0DSc6bMOBBREZxSDJ+BmRzc8B5OdaMh1ty3mkuWRg4sCFiDQQ==",
|
"integrity": "sha512-CXe0JHCXru8Fa36dteXqmH2YxngKJjkQLjxzoj6LYwzZ7qZvgsLSc+eqItCrqIop8Vl2UKoAi0StVWu97FQZIQ==",
|
||||||
"dev": true,
|
"dev": true,
|
||||||
"requires": {
|
"requires": {
|
||||||
"@typescript-eslint/types": "7.7.0",
|
"@typescript-eslint/types": "7.7.1",
|
||||||
"@typescript-eslint/visitor-keys": "7.7.0",
|
"@typescript-eslint/visitor-keys": "7.7.1",
|
||||||
"debug": "^4.3.4",
|
"debug": "^4.3.4",
|
||||||
"globby": "^11.1.0",
|
"globby": "^11.1.0",
|
||||||
"is-glob": "^4.0.3",
|
"is-glob": "^4.0.3",
|
||||||
@ -4726,17 +4726,17 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"@typescript-eslint/utils": {
|
"@typescript-eslint/utils": {
|
||||||
"version": "7.7.0",
|
"version": "7.7.1",
|
||||||
"resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-7.7.0.tgz",
|
"resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-7.7.1.tgz",
|
||||||
"integrity": "sha512-LKGAXMPQs8U/zMRFXDZOzmMKgFv3COlxUQ+2NMPhbqgVm6R1w+nU1i4836Pmxu9jZAuIeyySNrN/6Rc657ggig==",
|
"integrity": "sha512-QUvBxPEaBXf41ZBbaidKICgVL8Hin0p6prQDu6bbetWo39BKbWJxRsErOzMNT1rXvTll+J7ChrbmMCXM9rsvOQ==",
|
||||||
"dev": true,
|
"dev": true,
|
||||||
"requires": {
|
"requires": {
|
||||||
"@eslint-community/eslint-utils": "^4.4.0",
|
"@eslint-community/eslint-utils": "^4.4.0",
|
||||||
"@types/json-schema": "^7.0.15",
|
"@types/json-schema": "^7.0.15",
|
||||||
"@types/semver": "^7.5.8",
|
"@types/semver": "^7.5.8",
|
||||||
"@typescript-eslint/scope-manager": "7.7.0",
|
"@typescript-eslint/scope-manager": "7.7.1",
|
||||||
"@typescript-eslint/types": "7.7.0",
|
"@typescript-eslint/types": "7.7.1",
|
||||||
"@typescript-eslint/typescript-estree": "7.7.0",
|
"@typescript-eslint/typescript-estree": "7.7.1",
|
||||||
"semver": "^7.6.0"
|
"semver": "^7.6.0"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
@ -4752,12 +4752,12 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"@typescript-eslint/visitor-keys": {
|
"@typescript-eslint/visitor-keys": {
|
||||||
"version": "7.7.0",
|
"version": "7.7.1",
|
||||||
"resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-7.7.0.tgz",
|
"resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-7.7.1.tgz",
|
||||||
"integrity": "sha512-h0WHOj8MhdhY8YWkzIF30R379y0NqyOHExI9N9KCzvmu05EgG4FumeYa3ccfKUSphyWkWQE1ybVrgz/Pbam6YA==",
|
"integrity": "sha512-gBL3Eq25uADw1LQ9kVpf3hRM+DWzs0uZknHYK3hq4jcTPqVCClHGDnB6UUUV2SFeBeA4KWHWbbLqmbGcZ4FYbw==",
|
||||||
"dev": true,
|
"dev": true,
|
||||||
"requires": {
|
"requires": {
|
||||||
"@typescript-eslint/types": "7.7.0",
|
"@typescript-eslint/types": "7.7.1",
|
||||||
"eslint-visitor-keys": "^3.4.3"
|
"eslint-visitor-keys": "^3.4.3"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
@ -36,8 +36,8 @@
|
|||||||
"tmp": "^0.2.3"
|
"tmp": "^0.2.3"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@typescript-eslint/eslint-plugin": "^7.7.0",
|
"@typescript-eslint/eslint-plugin": "^7.7.1",
|
||||||
"@typescript-eslint/parser": "^7.7.0",
|
"@typescript-eslint/parser": "^7.7.1",
|
||||||
"@vercel/ncc": "^0.38.1",
|
"@vercel/ncc": "^0.38.1",
|
||||||
"eslint": "^8.57.0",
|
"eslint": "^8.57.0",
|
||||||
"eslint-config-prettier": "^9.1.0",
|
"eslint-config-prettier": "^9.1.0",
|
||||||
|
56
src/cache.ts
56
src/cache.ts
@ -23,28 +23,13 @@ const getLintCacheDir = (): string => {
|
|||||||
return path.resolve(`${process.env.HOME}/.cache/golangci-lint`)
|
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 getIntervalKey = (invalidationIntervalDays: number): string => {
|
||||||
const now = new Date()
|
const now = new Date()
|
||||||
|
|
||||||
|
if (invalidationIntervalDays <= 0) {
|
||||||
|
return `${now.getTime()}`
|
||||||
|
}
|
||||||
|
|
||||||
const secondsSinceEpoch = now.getTime() / 1000
|
const secondsSinceEpoch = now.getTime() / 1000
|
||||||
const intervalNumber = Math.floor(secondsSinceEpoch / (invalidationIntervalDays * 86400))
|
const intervalNumber = Math.floor(secondsSinceEpoch / (invalidationIntervalDays * 86400))
|
||||||
return intervalNumber.toString()
|
return intervalNumber.toString()
|
||||||
@ -52,28 +37,42 @@ const getIntervalKey = (invalidationIntervalDays: number): string => {
|
|||||||
|
|
||||||
async function buildCacheKeys(): Promise<string[]> {
|
async function buildCacheKeys(): Promise<string[]> {
|
||||||
const keys = []
|
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
|
// Get working directory from input
|
||||||
const workingDirectory = core.getInput(`working-directory`)
|
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
|
// create path to go.mod prepending the workingDirectory if it exists
|
||||||
const goModPath = path.join(workingDirectory, `go.mod`)
|
const goModPath = path.join(workingDirectory, `go.mod`)
|
||||||
|
|
||||||
core.info(`Checking for go.mod: ${goModPath}`)
|
core.info(`Checking for go.mod: ${goModPath}`)
|
||||||
|
|
||||||
if (await pathExists(goModPath)) {
|
if (await pathExists(goModPath)) {
|
||||||
// Add checksum to key to invalidate a cache when dependencies change.
|
// Add checksum to key to invalidate a cache when dependencies change.
|
||||||
cacheKey += await checksumFile(`sha1`, goModPath)
|
cacheKey += await checksumFile(`sha1`, goModPath)
|
||||||
} else {
|
} else {
|
||||||
cacheKey += `nogomod`
|
cacheKey += `nogomod`
|
||||||
}
|
}
|
||||||
|
|
||||||
keys.push(cacheKey)
|
keys.push(cacheKey)
|
||||||
|
|
||||||
return keys
|
return keys
|
||||||
}
|
}
|
||||||
|
|
||||||
export async function restoreCache(): Promise<void> {
|
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()) {
|
if (!utils.isValidEvent()) {
|
||||||
utils.logWarning(
|
utils.logWarning(
|
||||||
@ -97,7 +96,7 @@ export async function restoreCache(): Promise<void> {
|
|||||||
}
|
}
|
||||||
core.saveState(State.CachePrimaryKey, primaryKey)
|
core.saveState(State.CachePrimaryKey, primaryKey)
|
||||||
try {
|
try {
|
||||||
const cacheKey = await cache.restoreCache(getCacheDirs(), primaryKey, restoreKeys)
|
const cacheKey = await cache.restoreCache([getLintCacheDir()], primaryKey, restoreKeys)
|
||||||
if (!cacheKey) {
|
if (!cacheKey) {
|
||||||
core.info(`Cache not found for input keys: ${[primaryKey, ...restoreKeys].join(", ")}`)
|
core.info(`Cache not found for input keys: ${[primaryKey, ...restoreKeys].join(", ")}`)
|
||||||
return
|
return
|
||||||
@ -115,7 +114,8 @@ export async function restoreCache(): Promise<void> {
|
|||||||
}
|
}
|
||||||
|
|
||||||
export async function saveCache(): 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
|
// Validate inputs, this can cause task failure
|
||||||
if (!utils.isValidEvent()) {
|
if (!utils.isValidEvent()) {
|
||||||
@ -127,7 +127,7 @@ export async function saveCache(): Promise<void> {
|
|||||||
|
|
||||||
const startedAt = Date.now()
|
const startedAt = Date.now()
|
||||||
|
|
||||||
const cacheDirs = getCacheDirs()
|
const cacheDirs = [getLintCacheDir()]
|
||||||
const primaryKey = core.getState(State.CachePrimaryKey)
|
const primaryKey = core.getState(State.CachePrimaryKey)
|
||||||
if (!primaryKey) {
|
if (!primaryKey) {
|
||||||
utils.logWarning(`Error retrieving key from state.`)
|
utils.logWarning(`Error retrieving key from state.`)
|
||||||
|
141
src/run.ts
141
src/run.ts
@ -1,5 +1,6 @@
|
|||||||
import * as core from "@actions/core"
|
import * as core from "@actions/core"
|
||||||
import * as github from "@actions/github"
|
import * as github from "@actions/github"
|
||||||
|
import { Context } from "@actions/github/lib/context"
|
||||||
import { exec, ExecOptions } from "child_process"
|
import { exec, ExecOptions } from "child_process"
|
||||||
import * as fs from "fs"
|
import * as fs from "fs"
|
||||||
import * as path from "path"
|
import * as path from "path"
|
||||||
@ -15,6 +16,10 @@ const execShellCommand = promisify(exec)
|
|||||||
const writeFile = promisify(fs.writeFile)
|
const writeFile = promisify(fs.writeFile)
|
||||||
const createTempDir = promisify(dir)
|
const createTempDir = promisify(dir)
|
||||||
|
|
||||||
|
function isOnlyNewIssues(): boolean {
|
||||||
|
return core.getBooleanInput(`only-new-issues`, { required: true })
|
||||||
|
}
|
||||||
|
|
||||||
async function prepareLint(): Promise<string> {
|
async function prepareLint(): Promise<string> {
|
||||||
const mode = core.getInput("install-mode").toLowerCase()
|
const mode = core.getInput("install-mode").toLowerCase()
|
||||||
const versionConfig = await findLintVersion(<InstallMode>mode)
|
const versionConfig = await findLintVersion(<InstallMode>mode)
|
||||||
@ -23,31 +28,42 @@ async function prepareLint(): Promise<string> {
|
|||||||
}
|
}
|
||||||
|
|
||||||
async function fetchPatch(): 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 ``
|
return ``
|
||||||
}
|
}
|
||||||
|
|
||||||
const ctx = github.context
|
const ctx = github.context
|
||||||
if (ctx.eventName !== `pull_request`) {
|
|
||||||
core.info(`Not fetching patch for showing only new issues because it's not a pull request context: event name is ${ctx.eventName}`)
|
switch (ctx.eventName) {
|
||||||
return ``
|
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`)
|
core.warning(`No pull request in context`)
|
||||||
return ``
|
return ``
|
||||||
}
|
}
|
||||||
|
|
||||||
const octokit = github.getOctokit(core.getInput(`github-token`, { required: true }))
|
const octokit = github.getOctokit(core.getInput(`github-token`, { required: true }))
|
||||||
|
|
||||||
let patch: string
|
let patch: string
|
||||||
try {
|
try {
|
||||||
const patchResp = await octokit.rest.pulls.get({
|
const patchResp = await octokit.rest.pulls.get({
|
||||||
owner: ctx.repo.owner,
|
owner: ctx.repo.owner,
|
||||||
repo: ctx.repo.repo,
|
repo: ctx.repo.repo,
|
||||||
[`pull_number`]: pull.number,
|
[`pull_number`]: pr.number,
|
||||||
mediaType: {
|
mediaType: {
|
||||||
format: `diff`,
|
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 = {
|
type Env = {
|
||||||
lintPath: string
|
lintPath: string
|
||||||
patchPath: string
|
patchPath: string
|
||||||
@ -87,11 +141,9 @@ async function prepareEnv(): Promise<Env> {
|
|||||||
|
|
||||||
// Prepare cache, lint and go in parallel.
|
// Prepare cache, lint and go in parallel.
|
||||||
await restoreCache()
|
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`)
|
core.info(`Prepared env in ${Date.now() - startedAt}ms`)
|
||||||
|
|
||||||
@ -133,30 +185,57 @@ async function runLint(lintPath: string, patchPath: string): Promise<void> {
|
|||||||
const userArgsMap = new Map<string, string>(userArgsList)
|
const userArgsMap = new Map<string, string>(userArgsList)
|
||||||
const userArgNames = new Set<string>(userArgsList.map(([key]) => key))
|
const userArgNames = new Set<string>(userArgsList.map(([key]) => key))
|
||||||
|
|
||||||
const formats = (userArgsMap.get("out-format") || "")
|
const annotations = core.getBooleanInput(`annotations`)
|
||||||
.trim()
|
|
||||||
.split(",")
|
|
||||||
.filter((f) => f.length > 0)
|
|
||||||
.filter((f) => !f.startsWith(`github-actions`))
|
|
||||||
.concat("github-actions")
|
|
||||||
.join(",")
|
|
||||||
|
|
||||||
addedArgs.push(`--out-format=${formats}`)
|
if (annotations) {
|
||||||
userArgs = userArgs.replace(/--out-format=\S*/gi, "").trim()
|
const formats = (userArgsMap.get("out-format") || "")
|
||||||
|
.trim()
|
||||||
|
.split(",")
|
||||||
|
.filter((f) => f.length > 0)
|
||||||
|
.filter((f) => !f.startsWith(`github-actions`))
|
||||||
|
.concat("github-actions")
|
||||||
|
.join(",")
|
||||||
|
|
||||||
if (patchPath) {
|
addedArgs.push(`--out-format=${formats}`)
|
||||||
|
userArgs = userArgs.replace(/--out-format=\S*/gi, "").trim()
|
||||||
|
}
|
||||||
|
|
||||||
|
if (isOnlyNewIssues()) {
|
||||||
if (userArgNames.has(`new`) || userArgNames.has(`new-from-rev`) || userArgNames.has(`new-from-patch`)) {
|
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`)
|
throw new Error(`please, don't specify manually --new* args when requesting only new issues`)
|
||||||
}
|
}
|
||||||
addedArgs.push(`--new-from-patch=${patchPath}`)
|
|
||||||
|
|
||||||
// Override config values.
|
const ctx = github.context
|
||||||
addedArgs.push(`--new=false`)
|
|
||||||
addedArgs.push(`--new-from-rev=`)
|
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 workingDirectory = core.getInput(`working-directory`)
|
|
||||||
const cmdArgs: ExecOptions = {}
|
const cmdArgs: ExecOptions = {}
|
||||||
|
|
||||||
|
const workingDirectory = core.getInput(`working-directory`)
|
||||||
if (workingDirectory) {
|
if (workingDirectory) {
|
||||||
if (!fs.existsSync(workingDirectory) || !fs.lstatSync(workingDirectory).isDirectory()) {
|
if (!fs.existsSync(workingDirectory) || !fs.lstatSync(workingDirectory).isDirectory()) {
|
||||||
throw new Error(`working-directory (${workingDirectory}) was not a path`)
|
throw new Error(`working-directory (${workingDirectory}) was not a path`)
|
||||||
@ -169,7 +248,7 @@ async function runLint(lintPath: string, patchPath: string): Promise<void> {
|
|||||||
|
|
||||||
const cmd = `${lintPath} run ${addedArgs.join(` `)} ${userArgs}`.trimEnd()
|
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()
|
const startedAt = Date.now()
|
||||||
try {
|
try {
|
||||||
|
Reference in New Issue
Block a user