mirror of
https://github.com/golangci/golangci-lint-action.git
synced 2026-01-16 04:14:30 +07:00
Compare commits
27 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
de73c35617 | ||
|
|
f75f4b02ef | ||
|
|
f75c1c4ee8 | ||
|
|
e9dc9291fd | ||
|
|
2e568c9b8b | ||
|
|
6ad01b21aa | ||
|
|
ef750330e2 | ||
|
|
3ab2377cc3 | ||
|
|
ca80beefdd | ||
|
|
87a373f691 | ||
|
|
7fa6da85a5 | ||
|
|
1e7e51e771 | ||
|
|
5256ff0c0a | ||
|
|
13fed6f911 | ||
|
|
7afe8ff863 | ||
|
|
5a9289952f | ||
|
|
aa6fad0ea0 | ||
|
|
a6071aaacb | ||
|
|
6e36c8460f | ||
|
|
e7fa5ac41e | ||
|
|
f3ae99f5f5 | ||
|
|
1dfda283ac | ||
|
|
8b0f9424d0 | ||
|
|
a77756c838 | ||
|
|
37a9fafcae | ||
|
|
199a9c2889 | ||
|
|
c7c1219093 |
9
.github/workflows/codeql.yaml
vendored
9
.github/workflows/codeql.yaml
vendored
@@ -11,6 +11,11 @@ on:
|
||||
schedule:
|
||||
- cron: '0 17 * * 5'
|
||||
|
||||
permissions:
|
||||
actions: read
|
||||
contents: read
|
||||
security-events: write
|
||||
|
||||
jobs:
|
||||
codeQL:
|
||||
# CodeQL runs on ubuntu-latest, windows-latest, and macos-latest
|
||||
@@ -18,7 +23,7 @@ jobs:
|
||||
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v5
|
||||
uses: actions/checkout@v6
|
||||
with:
|
||||
# Must fetch at least the immediate parents so that if this is
|
||||
# a pull request then we can checkout the head of the pull request.
|
||||
@@ -36,7 +41,7 @@ jobs:
|
||||
uses: github/codeql-action/init@v4
|
||||
# Override language selection by uncommenting this and choosing your languages
|
||||
with:
|
||||
language: 'javascript'
|
||||
languages: 'javascript-typescript'
|
||||
|
||||
- run: |
|
||||
npm install
|
||||
|
||||
77
.github/workflows/test.yml
vendored
77
.github/workflows/test.yml
vendored
@@ -1,5 +1,6 @@
|
||||
name: "build-and-test"
|
||||
on: # rebuild any PRs and main branch changes
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
branches:
|
||||
- main
|
||||
@@ -7,22 +8,27 @@ on: # rebuild any PRs and main branch changes
|
||||
branches:
|
||||
- main
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
|
||||
jobs:
|
||||
build: # make sure build/ci work properly
|
||||
# make sure build/ci work properly
|
||||
build:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/setup-node@v6
|
||||
with:
|
||||
node-version: 24.x
|
||||
- uses: actions/checkout@v5
|
||||
- uses: actions/checkout@v6
|
||||
- run: |
|
||||
npm install
|
||||
npm run all
|
||||
|
||||
# Fail the build if there is dirty change
|
||||
# Fail the build if there are changes.
|
||||
- run: git diff --exit-code -- dist
|
||||
|
||||
test: # make sure the action works on a clean machine without building
|
||||
# make sure the action works on a clean machine without building
|
||||
test:
|
||||
needs: [ build ]
|
||||
strategy:
|
||||
matrix:
|
||||
@@ -34,14 +40,14 @@ jobs:
|
||||
version:
|
||||
- ""
|
||||
- "latest"
|
||||
- "v2.5"
|
||||
- "v2.5.0"
|
||||
- "v2.7"
|
||||
- "v2.7.2"
|
||||
runs-on: ${{ matrix.os }}
|
||||
permissions:
|
||||
contents: read
|
||||
pull-requests: read
|
||||
steps:
|
||||
- uses: actions/checkout@v5
|
||||
- uses: actions/checkout@v6
|
||||
- uses: actions/setup-node@v6
|
||||
with:
|
||||
node-version: 24.x
|
||||
@@ -51,10 +57,11 @@ jobs:
|
||||
- uses: ./
|
||||
with:
|
||||
version: ${{ matrix.version }}
|
||||
args: --timeout=5m --issues-exit-code=0 ./sample/...
|
||||
args: --timeout=5m --issues-exit-code=0 ./fixtures/simple/...
|
||||
only-new-issues: true
|
||||
|
||||
test-go-install: # make sure the action works on a clean machine without building (go-install mode)
|
||||
# make sure the action works on a clean machine without building (go-install mode)
|
||||
test-go-install:
|
||||
needs: [ build ]
|
||||
strategy:
|
||||
matrix:
|
||||
@@ -66,14 +73,14 @@ jobs:
|
||||
version:
|
||||
- ""
|
||||
- "latest"
|
||||
- "v2.5.0"
|
||||
- "v2.7.2"
|
||||
- "655e8ede5178280b2a640e185bc4a343aed0f54e"
|
||||
runs-on: ${{ matrix.os }}
|
||||
permissions:
|
||||
contents: read
|
||||
pull-requests: read
|
||||
steps:
|
||||
- uses: actions/checkout@v5
|
||||
- uses: actions/checkout@v6
|
||||
- uses: actions/setup-node@v6
|
||||
with:
|
||||
node-version: 24.x
|
||||
@@ -83,7 +90,7 @@ jobs:
|
||||
- uses: ./
|
||||
with:
|
||||
version: ${{ matrix.version }}
|
||||
args: --timeout=5m --issues-exit-code=0 ./sample/...
|
||||
args: --timeout=5m --issues-exit-code=0 ./fixtures/simple/...
|
||||
only-new-issues: true
|
||||
install-mode: goinstall
|
||||
|
||||
@@ -97,13 +104,13 @@ jobs:
|
||||
- macos-latest
|
||||
- windows-latest
|
||||
wd:
|
||||
- sample-go-mod
|
||||
- sample-go-tool
|
||||
- fixtures/go-mod
|
||||
- fixtures/go-tool
|
||||
runs-on: ${{ matrix.os }}
|
||||
permissions:
|
||||
contents: read
|
||||
steps:
|
||||
- uses: actions/checkout@v5
|
||||
- uses: actions/checkout@v6
|
||||
- uses: actions/setup-node@v6
|
||||
with:
|
||||
node-version: 24.x
|
||||
@@ -115,7 +122,8 @@ jobs:
|
||||
working-directory: ${{ matrix.wd }}
|
||||
args: --timeout=5m --issues-exit-code=0 ./...
|
||||
|
||||
test-plugins: # make sure the action works on a clean machine with plugins
|
||||
# make sure the action works on a clean machine with plugins
|
||||
test-plugins:
|
||||
needs: [ build ]
|
||||
strategy:
|
||||
matrix:
|
||||
@@ -127,14 +135,14 @@ jobs:
|
||||
version:
|
||||
- ""
|
||||
- "latest"
|
||||
- "v2.5"
|
||||
- "v2.5.0"
|
||||
- "v2.7"
|
||||
- "v2.7.2"
|
||||
runs-on: ${{ matrix.os }}
|
||||
permissions:
|
||||
contents: read
|
||||
pull-requests: read
|
||||
steps:
|
||||
- uses: actions/checkout@v5
|
||||
- uses: actions/checkout@v6
|
||||
- uses: actions/setup-node@v6
|
||||
with:
|
||||
node-version: 24.x
|
||||
@@ -144,5 +152,32 @@ jobs:
|
||||
- uses: ./
|
||||
with:
|
||||
version: ${{ matrix.version }}
|
||||
working-directory: sample-plugins
|
||||
working-directory: fixtures/plugins
|
||||
args: --timeout=5m --issues-exit-code=0 ./...
|
||||
|
||||
test-monorepo:
|
||||
needs: [ build ]
|
||||
strategy:
|
||||
matrix:
|
||||
os:
|
||||
- ubuntu-latest
|
||||
- ubuntu-22.04-arm
|
||||
- macos-latest
|
||||
- windows-latest
|
||||
runs-on: ${{ matrix.os }}
|
||||
permissions:
|
||||
contents: read
|
||||
pull-requests: read
|
||||
steps:
|
||||
- uses: actions/checkout@v6
|
||||
- uses: actions/setup-node@v6
|
||||
with:
|
||||
node-version: 24.x
|
||||
- uses: actions/setup-go@v6
|
||||
with:
|
||||
go-version: oldstable
|
||||
- uses: ./
|
||||
with:
|
||||
working-directory: fixtures/monorepo
|
||||
experimental: "automatic-module-directories"
|
||||
args: --timeout=5m --issues-exit-code=0 ./...
|
||||
|
||||
258
README.md
258
README.md
@@ -54,9 +54,9 @@ jobs:
|
||||
with:
|
||||
go-version: stable
|
||||
- name: golangci-lint
|
||||
uses: golangci/golangci-lint-action@v8
|
||||
uses: golangci/golangci-lint-action@v9
|
||||
with:
|
||||
version: v2.1
|
||||
version: v2.6
|
||||
```
|
||||
|
||||
</details>
|
||||
@@ -92,9 +92,9 @@ jobs:
|
||||
with:
|
||||
go-version: ${{ matrix.go }}
|
||||
- name: golangci-lint
|
||||
uses: golangci/golangci-lint-action@v8
|
||||
uses: golangci/golangci-lint-action@v9
|
||||
with:
|
||||
version: v2.1
|
||||
version: v2.6
|
||||
```
|
||||
|
||||
You will also likely need to add the following `.gitattributes` file to ensure that line endings for Windows builds are properly formatted:
|
||||
@@ -120,7 +120,7 @@ on:
|
||||
|
||||
env:
|
||||
GO_VERSION: stable
|
||||
GOLANGCI_LINT_VERSION: v2.1
|
||||
GOLANGCI_LINT_VERSION: v2.6
|
||||
|
||||
jobs:
|
||||
detect-modules:
|
||||
@@ -147,7 +147,7 @@ jobs:
|
||||
with:
|
||||
go-version: ${{ env.GO_VERSION }}
|
||||
- name: golangci-lint ${{ matrix.modules }}
|
||||
uses: golangci/golangci-lint-action@v8
|
||||
uses: golangci/golangci-lint-action@v9
|
||||
with:
|
||||
version: ${{ env.GOLANGCI_LINT_VERSION }}
|
||||
working-directory: ${{ matrix.modules }}
|
||||
@@ -179,7 +179,7 @@ jobs:
|
||||
with:
|
||||
os: ${{ matrix.os }}
|
||||
go-version: ${{ matrix.go-version }}
|
||||
golangci-lint-version: v2.1
|
||||
golangci-lint-version: v2.6
|
||||
```
|
||||
|
||||
```yaml
|
||||
@@ -201,7 +201,7 @@ on:
|
||||
golangci-lint-version:
|
||||
description: 'Golangci-lint version'
|
||||
type: string
|
||||
default: 'v2.1'
|
||||
default: 'v2.6'
|
||||
|
||||
jobs:
|
||||
detect-modules:
|
||||
@@ -229,7 +229,7 @@ jobs:
|
||||
with:
|
||||
go-version: ${{ inputs.go-version }}
|
||||
- name: golangci-lint ${{ matrix.modules }}
|
||||
uses: golangci/golangci-lint-action@v8
|
||||
uses: golangci/golangci-lint-action@v9
|
||||
with:
|
||||
version: ${{ inputs.golangci-lint-version }}
|
||||
working-directory: ${{ matrix.modules }}
|
||||
@@ -259,7 +259,28 @@ You will also likely need to add the following `.gitattributes` file to ensure t
|
||||
|
||||
## Options
|
||||
|
||||
### `version`
|
||||
### Overview
|
||||
|
||||
| Option | Description |
|
||||
|---------------------------------------------------------------|-------------------------------------------------------|
|
||||
| [`version`](#version) | The version of golangci-lint to use. |
|
||||
| [`version-file`](#version-file) | Gets the version of golangci-lint to use from a file. |
|
||||
| [`install-mode`](#install-mode) | The mode to install golangci-lint. |
|
||||
| [`install-only`](#install-only) | Only install golangci-lint. |
|
||||
| [`verify`](#verify) | Validates golangci-lint configuration file. |
|
||||
| [`github-token`](#github-token) | Used by the `only-new-issues` option. |
|
||||
| [`only-new-issues`](#only-new-issues) | Show only new issues. |
|
||||
| [`working-directory`](#working-directory) | The golangci-lint working directory. |
|
||||
| [`args`](#args) | Golangci-lint command line arguments. |
|
||||
| [`skip-cache`](#skip-cache) | Disable cache support. |
|
||||
| [`skip-save-cache`](#skip-save-cache) | Don't save cache. |
|
||||
| [`cache-invalidation-interval`](#cache-invalidation-interval) | Number of days before cache invalidation. |
|
||||
| [`problem-matchers`](#problem-matchers) | Forces the usage of the embedded problem matchers. |
|
||||
| [Experimental](#experimental) | Experimental options |
|
||||
|
||||
### Installation
|
||||
|
||||
#### `version`
|
||||
|
||||
(optional)
|
||||
|
||||
@@ -274,15 +295,37 @@ When `install-mode` is:
|
||||
<summary>Example</summary>
|
||||
|
||||
```yml
|
||||
uses: golangci/golangci-lint-action@v8
|
||||
uses: golangci/golangci-lint-action@v9
|
||||
with:
|
||||
version: v2.1
|
||||
version: v2.6
|
||||
# ...
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
### `install-mode`
|
||||
#### `version-file`
|
||||
|
||||
Gets the version of golangci-lint to use from a file.
|
||||
|
||||
The path must be relative to the root of the project, or the `working-directory` if defined.
|
||||
|
||||
This parameter supports `.golangci-lint-version`, and `.tool-versions` files.
|
||||
|
||||
Only works with `install-mode: binary` (the default).
|
||||
|
||||
<details>
|
||||
<summary>Example</summary>
|
||||
|
||||
```yml
|
||||
uses: golangci/golangci-lint-action@v9
|
||||
with:
|
||||
version-file: .tool-versions
|
||||
# ...
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
#### `install-mode`
|
||||
|
||||
(optional)
|
||||
|
||||
@@ -296,7 +339,7 @@ The default value is `binary`.
|
||||
<summary>Example</summary>
|
||||
|
||||
```yml
|
||||
uses: golangci/golangci-lint-action@v8
|
||||
uses: golangci/golangci-lint-action@v9
|
||||
with:
|
||||
install-mode: "none"
|
||||
# ...
|
||||
@@ -304,7 +347,7 @@ with:
|
||||
|
||||
</details>
|
||||
|
||||
### `install-only`
|
||||
#### `install-only`
|
||||
|
||||
(optional)
|
||||
|
||||
@@ -317,7 +360,7 @@ The default value is `false`.
|
||||
<summary>Example</summary>
|
||||
|
||||
```yml
|
||||
uses: golangci/golangci-lint-action@v8
|
||||
uses: golangci/golangci-lint-action@v9
|
||||
with:
|
||||
install-only: true
|
||||
# ...
|
||||
@@ -325,27 +368,9 @@ with:
|
||||
|
||||
</details>
|
||||
|
||||
### `github-token`
|
||||
### Run
|
||||
|
||||
(optional)
|
||||
|
||||
When using the `only-new-issues` option, the GitHub API is used, so a token is required.
|
||||
|
||||
By default, it uses the `github.token` from the action.
|
||||
|
||||
<details>
|
||||
<summary>Example</summary>
|
||||
|
||||
```yml
|
||||
uses: golangci/golangci-lint-action@v8
|
||||
with:
|
||||
github-token: xxx
|
||||
# ...
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
### `verify`
|
||||
#### `verify`
|
||||
|
||||
(optional)
|
||||
|
||||
@@ -360,7 +385,7 @@ The JSON Schema used to validate the configuration depends on the version of gol
|
||||
<summary>Example</summary>
|
||||
|
||||
```yml
|
||||
uses: golangci/golangci-lint-action@v8
|
||||
uses: golangci/golangci-lint-action@v9
|
||||
with:
|
||||
verify: false
|
||||
# ...
|
||||
@@ -368,7 +393,27 @@ with:
|
||||
|
||||
</details>
|
||||
|
||||
### `only-new-issues`
|
||||
#### `github-token`
|
||||
|
||||
(optional)
|
||||
|
||||
When using the `only-new-issues` option, the GitHub API is used, so a token is required.
|
||||
|
||||
By default, it uses the `github.token` from the action.
|
||||
|
||||
<details>
|
||||
<summary>Example</summary>
|
||||
|
||||
```yml
|
||||
uses: golangci/golangci-lint-action@v9
|
||||
with:
|
||||
github-token: xxx
|
||||
# ...
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
#### `only-new-issues`
|
||||
|
||||
(optional)
|
||||
|
||||
@@ -385,7 +430,7 @@ The default value is `false`.
|
||||
<summary>Example</summary>
|
||||
|
||||
```yml
|
||||
uses: golangci/golangci-lint-action@v8
|
||||
uses: golangci/golangci-lint-action@v9
|
||||
with:
|
||||
only-new-issues: true
|
||||
# ...
|
||||
@@ -393,7 +438,7 @@ with:
|
||||
|
||||
</details>
|
||||
|
||||
### `working-directory`
|
||||
#### `working-directory`
|
||||
|
||||
(optional)
|
||||
|
||||
@@ -403,7 +448,7 @@ The golangci-lint working directory, useful for monorepos. The default is the pr
|
||||
<summary>Example</summary>
|
||||
|
||||
```yml
|
||||
uses: golangci/golangci-lint-action@v8
|
||||
uses: golangci/golangci-lint-action@v9
|
||||
with:
|
||||
working-directory: somedir
|
||||
# ...
|
||||
@@ -411,7 +456,7 @@ with:
|
||||
|
||||
</details>
|
||||
|
||||
### `args`
|
||||
#### `args`
|
||||
|
||||
(optional)
|
||||
|
||||
@@ -428,7 +473,7 @@ golangci-lint command line arguments.
|
||||
<summary>Example</summary>
|
||||
|
||||
```yml
|
||||
uses: golangci/golangci-lint-action@v8
|
||||
uses: golangci/golangci-lint-action@v9
|
||||
with:
|
||||
# In some rare cases,
|
||||
# you may need to use `${{ github.workspace }}` as the base directory to reference your configuration file.
|
||||
@@ -438,7 +483,74 @@ with:
|
||||
|
||||
</details>
|
||||
|
||||
### `problem-matchers`
|
||||
### Cache
|
||||
|
||||
#### `skip-cache`
|
||||
|
||||
(optional)
|
||||
|
||||
If set to `true`, all caching functionality will be completely disabled.
|
||||
This takes precedence over all other caching options.
|
||||
|
||||
The default value is `false`.
|
||||
|
||||
<details>
|
||||
<summary>Example</summary>
|
||||
|
||||
```yml
|
||||
uses: golangci/golangci-lint-action@v9
|
||||
with:
|
||||
skip-cache: true
|
||||
# ...
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
#### `skip-save-cache`
|
||||
|
||||
(optional)
|
||||
|
||||
If set to `true`, caches will not be saved, but they may still be restored, requiring `skip-cache: false`.
|
||||
|
||||
The default value is `false`.
|
||||
|
||||
<details>
|
||||
<summary>Example</summary>
|
||||
|
||||
```yml
|
||||
uses: golangci/golangci-lint-action@v9
|
||||
with:
|
||||
skip-save-cache: true
|
||||
# ...
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
#### `cache-invalidation-interval`
|
||||
|
||||
(optional)
|
||||
|
||||
Periodically invalidate a cache every `cache-invalidation-interval` days to ensure that outdated data is removed and fresh data is loaded.
|
||||
|
||||
The default value is `7`.
|
||||
|
||||
If the number is `<= 0`, the cache will always be invalidated (not recommended).
|
||||
|
||||
<details>
|
||||
<summary>Example</summary>
|
||||
|
||||
```yml
|
||||
uses: golangci/golangci-lint-action@v9
|
||||
with:
|
||||
cache-invalidation-interval: 15
|
||||
# ...
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
### Extra
|
||||
|
||||
#### `problem-matchers`
|
||||
|
||||
(optional)
|
||||
|
||||
@@ -456,7 +568,7 @@ The default value is `false`.
|
||||
<summary>Example</summary>
|
||||
|
||||
```yml
|
||||
uses: golangci/golangci-lint-action@v8
|
||||
uses: golangci/golangci-lint-action@v9
|
||||
with:
|
||||
problem-matchers: true
|
||||
# ...
|
||||
@@ -464,65 +576,43 @@ with:
|
||||
|
||||
</details>
|
||||
|
||||
### `skip-cache`
|
||||
### Experimental
|
||||
|
||||
(optional)
|
||||
The following options are experimental: those may or may not be supported in the future, and so they will be either converted into a dedicated option or removed.
|
||||
|
||||
If set to `true`, all caching functionality will be completely disabled.
|
||||
This takes precedence over all other caching options.
|
||||
|
||||
The default value is `false`.
|
||||
List of comma-separated options.
|
||||
|
||||
<details>
|
||||
<summary>Example</summary>
|
||||
|
||||
```yml
|
||||
uses: golangci/golangci-lint-action@v8
|
||||
```yaml
|
||||
uses: golangci/golangci-lint-action@v9
|
||||
with:
|
||||
skip-cache: true
|
||||
# ...
|
||||
experimental: "foo,bar"
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
### `skip-save-cache`
|
||||
#### `automatic-module-directories`
|
||||
|
||||
(optional)
|
||||
|
||||
If set to `true`, caches will not be saved, but they may still be restored, requiring `skip-cache: false`.
|
||||
This option will run golangci-lint in each module directory, useful for monorepos.
|
||||
|
||||
The default value is `false`.
|
||||
The automatic detection of modules uses the `working-directory` as the base directory if defined, otherwise the root directory.
|
||||
|
||||
> [!IMPORTANT]
|
||||
> - The cache key will refer to the `working-directory` (if defined) because all the golangci-lint runs must use the same cache directory/key.
|
||||
> - The version detection will only work if the project has a single module.
|
||||
> - If the project has multiple modules, the custom build file must be located in the repository root ( or `working-directory`).
|
||||
|
||||
<details>
|
||||
<summary>Example</summary>
|
||||
|
||||
```yml
|
||||
uses: golangci/golangci-lint-action@v8
|
||||
```yaml
|
||||
uses: golangci/golangci-lint-action@v9
|
||||
with:
|
||||
skip-save-cache: true
|
||||
# ...
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
### `cache-invalidation-interval`
|
||||
|
||||
(optional)
|
||||
|
||||
Periodically invalidate a cache every `cache-invalidation-interval` days to ensure that outdated data is removed and fresh data is loaded.
|
||||
|
||||
The default value is `7`.
|
||||
|
||||
If the number is `<= 0`, the cache will always be invalidated (not recommended).
|
||||
|
||||
<details>
|
||||
<summary>Example</summary>
|
||||
|
||||
```yml
|
||||
uses: golangci/golangci-lint-action@v8
|
||||
with:
|
||||
cache-invalidation-interval: 15
|
||||
# ...
|
||||
experimental: "automatic-module-directories"
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
34
action.yml
34
action.yml
@@ -11,6 +11,13 @@ inputs:
|
||||
- `goinstall`: the value can be v2.3.4, `latest`, or the hash of a commit.
|
||||
- `none`: the value is ignored.
|
||||
required: false
|
||||
version-file:
|
||||
description: |
|
||||
Gets the version of golangci-lint to use from a file.
|
||||
The path must be relative to the root of the project, or the `working-directory` if defined.
|
||||
This parameter supports `.golangci-lint-version`, and `.tool-versions` files.
|
||||
Only works with `install-mode: binary` (the default).
|
||||
required: false
|
||||
install-mode:
|
||||
description: "The mode to install golangci-lint. It can be 'binary', 'goinstall', or 'none'."
|
||||
default: "binary"
|
||||
@@ -34,6 +41,10 @@ inputs:
|
||||
description: "If set to true and the action runs on a pull request, the action outputs only newly found issues."
|
||||
default: 'false'
|
||||
required: false
|
||||
args:
|
||||
description: "golangci-lint command line arguments."
|
||||
default: ""
|
||||
required: false
|
||||
skip-cache:
|
||||
description: |
|
||||
If set to true, all caching functionality will be completely disabled.
|
||||
@@ -42,21 +53,30 @@ inputs:
|
||||
required: false
|
||||
skip-save-cache:
|
||||
description: |
|
||||
If set to true, the action will not save any caches, but it may still
|
||||
restore existing caches, subject to other options.
|
||||
If set to true, the action will not save any caches,
|
||||
but it may still restore existing caches, subject to other options.
|
||||
default: 'false'
|
||||
required: false
|
||||
cache-invalidation-interval:
|
||||
description: "Periodically invalidate a cache when new code is added (number of days)."
|
||||
default: '7'
|
||||
required: false
|
||||
problem-matchers:
|
||||
description: "Force the usage of the embedded problem matchers."
|
||||
default: 'false'
|
||||
required: false
|
||||
args:
|
||||
description: "golangci-lint command line arguments."
|
||||
debug:
|
||||
description: |
|
||||
Debug options for the action.
|
||||
List of comma separated options, the values are `cache`, `clean`.
|
||||
example: "cache,clean"
|
||||
default: ""
|
||||
required: false
|
||||
cache-invalidation-interval:
|
||||
description: "Periodically invalidate a cache when new code is added (number of days)."
|
||||
default: '7'
|
||||
experimental:
|
||||
description: |
|
||||
Experimental options for the action.
|
||||
List of comma separated options.
|
||||
default: ""
|
||||
required: false
|
||||
runs:
|
||||
using: "node24"
|
||||
|
||||
98501
dist/post_run/index.js
generated
vendored
98501
dist/post_run/index.js
generated
vendored
File diff suppressed because one or more lines are too long
98501
dist/run/index.js
generated
vendored
98501
dist/run/index.js
generated
vendored
File diff suppressed because one or more lines are too long
@@ -1,4 +1,4 @@
|
||||
module sample
|
||||
module github.com/golangci/sample
|
||||
|
||||
go 1.24.0
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
module sample
|
||||
module github.com/golangci/sample
|
||||
|
||||
go 1.24.0
|
||||
|
||||
3
fixtures/monorepo/a/go.mod
Normal file
3
fixtures/monorepo/a/go.mod
Normal file
@@ -0,0 +1,3 @@
|
||||
module github.com/golangci/actiona
|
||||
|
||||
go 1.24.0
|
||||
3
fixtures/monorepo/a/suba/go.mod
Normal file
3
fixtures/monorepo/a/suba/go.mod
Normal file
@@ -0,0 +1,3 @@
|
||||
module github.com/golangci/actiona/suba
|
||||
|
||||
go 1.24.0
|
||||
26
fixtures/monorepo/a/suba/sample.go
Normal file
26
fixtures/monorepo/a/suba/sample.go
Normal file
@@ -0,0 +1,26 @@
|
||||
// Package sample is used as test input for golangci action.
|
||||
package sample
|
||||
|
||||
import (
|
||||
"crypto/md5"
|
||||
"encoding/hex"
|
||||
"errors"
|
||||
)
|
||||
|
||||
// Hash~
|
||||
func Hash(data string) string {
|
||||
retError()
|
||||
retError2()
|
||||
|
||||
h := md5.New()
|
||||
h.Write([]byte(data))
|
||||
return hex.EncodeToString(h.Sum(nil))
|
||||
}
|
||||
|
||||
func retError() error {
|
||||
return errors.New("err")
|
||||
}
|
||||
|
||||
func retError2() error {
|
||||
return errors.New("err2")
|
||||
}
|
||||
3
fixtures/monorepo/b/go.mod
Normal file
3
fixtures/monorepo/b/go.mod
Normal file
@@ -0,0 +1,3 @@
|
||||
module github.com/golangci/actionb
|
||||
|
||||
go 1.24.0
|
||||
26
fixtures/monorepo/b/sample.go
Normal file
26
fixtures/monorepo/b/sample.go
Normal file
@@ -0,0 +1,26 @@
|
||||
// Package sample is used as test input for golangci action.
|
||||
package sample
|
||||
|
||||
import (
|
||||
"crypto/md5"
|
||||
"encoding/hex"
|
||||
"errors"
|
||||
)
|
||||
|
||||
// Hash~
|
||||
func Hash(data string) string {
|
||||
retError()
|
||||
retError2()
|
||||
|
||||
h := md5.New()
|
||||
h.Write([]byte(data))
|
||||
return hex.EncodeToString(h.Sum(nil))
|
||||
}
|
||||
|
||||
func retError() error {
|
||||
return errors.New("err")
|
||||
}
|
||||
|
||||
func retError2() error {
|
||||
return errors.New("err2")
|
||||
}
|
||||
3
fixtures/monorepo/c/go.mod
Normal file
3
fixtures/monorepo/c/go.mod
Normal file
@@ -0,0 +1,3 @@
|
||||
module github.com/golangci/actionc
|
||||
|
||||
go 1.24.0
|
||||
26
fixtures/monorepo/c/sample.go
Normal file
26
fixtures/monorepo/c/sample.go
Normal file
@@ -0,0 +1,26 @@
|
||||
// Package sample is used as test input for golangci action.
|
||||
package sample
|
||||
|
||||
import (
|
||||
"crypto/md5"
|
||||
"encoding/hex"
|
||||
"errors"
|
||||
)
|
||||
|
||||
// Hash~
|
||||
func Hash(data string) string {
|
||||
retError()
|
||||
retError2()
|
||||
|
||||
h := md5.New()
|
||||
h.Write([]byte(data))
|
||||
return hex.EncodeToString(h.Sum(nil))
|
||||
}
|
||||
|
||||
func retError() error {
|
||||
return errors.New("err")
|
||||
}
|
||||
|
||||
func retError2() error {
|
||||
return errors.New("err2")
|
||||
}
|
||||
26
fixtures/simple/sample.go
Normal file
26
fixtures/simple/sample.go
Normal file
@@ -0,0 +1,26 @@
|
||||
// Package sample is used as test input for golangci action.
|
||||
package sample
|
||||
|
||||
import (
|
||||
"crypto/md5"
|
||||
"encoding/hex"
|
||||
"errors"
|
||||
)
|
||||
|
||||
// Hash~
|
||||
func Hash(data string) string {
|
||||
retError()
|
||||
retError2()
|
||||
|
||||
h := md5.New()
|
||||
h.Write([]byte(data))
|
||||
return hex.EncodeToString(h.Sum(nil))
|
||||
}
|
||||
|
||||
func retError() error {
|
||||
return errors.New("err")
|
||||
}
|
||||
|
||||
func retError2() error {
|
||||
return errors.New("err2")
|
||||
}
|
||||
2
go.mod
2
go.mod
@@ -1,3 +1,3 @@
|
||||
module github.com/golangci/golangci-lint-action
|
||||
|
||||
go 1.23
|
||||
go 1.24.0
|
||||
|
||||
1145
package-lock.json
generated
1145
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
20
package.json
20
package.json
@@ -27,23 +27,23 @@
|
||||
"node": ">=24.0.0"
|
||||
},
|
||||
"dependencies": {
|
||||
"@actions/cache": "^4.1.0",
|
||||
"@actions/core": "^1.11.1",
|
||||
"@actions/exec": "^1.1.1",
|
||||
"@actions/github": "^6.0.1",
|
||||
"@actions/cache": "^5.0.2",
|
||||
"@actions/core": "^2.0.2",
|
||||
"@actions/exec": "^2.0.0",
|
||||
"@actions/github": "^7.0.0",
|
||||
"@actions/http-client": "^3.0.0",
|
||||
"@octokit/plugin-retry": "^6.1.0",
|
||||
"@actions/tool-cache": "^2.0.2",
|
||||
"@types/node": "^24.10.0",
|
||||
"@actions/tool-cache": "^3.0.0",
|
||||
"@types/node": "^25.0.6",
|
||||
"@types/semver": "^7.7.1",
|
||||
"@types/tmp": "^0.2.6",
|
||||
"@types/which": "^3.0.4",
|
||||
"tmp": "^0.2.5",
|
||||
"which": "^5.0.0",
|
||||
"yaml": "^2.8.1"
|
||||
"which": "^6.0.0",
|
||||
"yaml": "^2.8.2"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@typescript-eslint/eslint-plugin": "^8.46.2",
|
||||
"@typescript-eslint/eslint-plugin": "^8.52.0",
|
||||
"@typescript-eslint/parser": "^8.32.1",
|
||||
"@vercel/ncc": "^0.38.4",
|
||||
"eslint": "^8.57.1",
|
||||
@@ -51,7 +51,7 @@
|
||||
"eslint-plugin-import": "^2.32.0",
|
||||
"eslint-plugin-prettier": "^5.5.4",
|
||||
"eslint-plugin-simple-import-sort": "^12.1.1",
|
||||
"prettier": "^3.6.2",
|
||||
"prettier": "^3.7.4",
|
||||
"typescript": "^5.9.3"
|
||||
}
|
||||
}
|
||||
|
||||
16
src/cache.ts
16
src/cache.ts
@@ -74,7 +74,10 @@ async function buildCacheKeys(): Promise<string[]> {
|
||||
}
|
||||
|
||||
export async function restoreCache(): Promise<void> {
|
||||
if (core.getBooleanInput(`skip-cache`, { required: true })) return
|
||||
if (core.getBooleanInput(`skip-cache`, { required: true })) {
|
||||
core.info(`Skipping cache restoration`)
|
||||
return
|
||||
}
|
||||
|
||||
if (!utils.isValidEvent()) {
|
||||
utils.logWarning(
|
||||
@@ -116,8 +119,15 @@ export async function restoreCache(): Promise<void> {
|
||||
}
|
||||
|
||||
export async function saveCache(): Promise<void> {
|
||||
if (core.getBooleanInput(`skip-cache`, { required: true })) return
|
||||
if (core.getBooleanInput(`skip-save-cache`, { required: true })) return
|
||||
if (core.getBooleanInput(`skip-cache`, { required: true })) {
|
||||
core.info(`Skipping cache saving`)
|
||||
return
|
||||
}
|
||||
|
||||
if (core.getBooleanInput(`skip-save-cache`, { required: true })) {
|
||||
core.info(`Skipping cache saving`)
|
||||
return
|
||||
}
|
||||
|
||||
// Validate inputs, this can cause task failure
|
||||
if (!utils.isValidEvent()) {
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
import * as core from "@actions/core"
|
||||
import * as tc from "@actions/tool-cache"
|
||||
import { exec, ExecOptionsWithStringEncoding } from "child_process"
|
||||
import fs from "fs"
|
||||
import os from "os"
|
||||
import path from "path"
|
||||
import { promisify } from "util"
|
||||
@@ -8,7 +9,7 @@ import which from "which"
|
||||
|
||||
import { getVersion, VersionInfo } from "./version"
|
||||
|
||||
const execShellCommand = promisify(exec)
|
||||
const execCommand = promisify(exec)
|
||||
|
||||
export enum InstallMode {
|
||||
Binary = "binary",
|
||||
@@ -21,13 +22,15 @@ type ExecRes = {
|
||||
stderr: string
|
||||
}
|
||||
|
||||
const printOutput = (res: ExecRes): void => {
|
||||
const printOutput = (res: ExecRes): ExecRes => {
|
||||
if (res.stdout) {
|
||||
core.info(res.stdout)
|
||||
}
|
||||
if (res.stderr) {
|
||||
core.info(res.stderr)
|
||||
}
|
||||
|
||||
return res
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -36,6 +39,17 @@ const printOutput = (res: ExecRes): void => {
|
||||
* @returns path to installed binary of golangci-lint.
|
||||
*/
|
||||
export async function install(): Promise<string> {
|
||||
const problemMatchers = core.getBooleanInput(`problem-matchers`)
|
||||
|
||||
if (problemMatchers) {
|
||||
const matchersPath = path.join(__dirname, "../..", "problem-matchers.json")
|
||||
if (fs.existsSync(matchersPath)) {
|
||||
// Adds problem matchers.
|
||||
// https://github.com/actions/setup-go/blob/cdcb36043654635271a94b9a6d1392de5bb323a7/src/main.ts#L81-L83
|
||||
core.info(`##[add-matcher]${matchersPath}`)
|
||||
}
|
||||
}
|
||||
|
||||
const mode = core.getInput("install-mode").toLowerCase()
|
||||
|
||||
if (mode === InstallMode.None) {
|
||||
@@ -84,17 +98,14 @@ async function goInstall(versionInfo: VersionInfo): Promise<string> {
|
||||
|
||||
const options: ExecOptionsWithStringEncoding = { env: { ...process.env, CGO_ENABLED: "1" } }
|
||||
|
||||
const exres = await execShellCommand(
|
||||
`go install github.com/golangci/golangci-lint/v2/cmd/golangci-lint@${versionInfo.TargetVersion}`,
|
||||
options
|
||||
await execCommand(`go install github.com/golangci/golangci-lint/v2/cmd/golangci-lint@${versionInfo.TargetVersion}`, options).then(
|
||||
printOutput
|
||||
)
|
||||
printOutput(exres)
|
||||
|
||||
const res = await execShellCommand(
|
||||
const res = await execCommand(
|
||||
`go install -n github.com/golangci/golangci-lint/v2/cmd/golangci-lint@${versionInfo.TargetVersion}`,
|
||||
options
|
||||
)
|
||||
printOutput(res)
|
||||
).then(printOutput)
|
||||
|
||||
// The output of `go install -n` when the binary is already installed is `touch <path_to_the_binary>`.
|
||||
const binPath = res.stderr
|
||||
|
||||
10
src/patch.ts
10
src/patch.ts
@@ -17,10 +17,6 @@ export function isOnlyNewIssues(): boolean {
|
||||
}
|
||||
|
||||
export async function fetchPatch(): Promise<string> {
|
||||
if (!isOnlyNewIssues()) {
|
||||
return ``
|
||||
}
|
||||
|
||||
const ctx = github.context
|
||||
|
||||
switch (ctx.eventName) {
|
||||
@@ -70,8 +66,7 @@ async function fetchPullRequestPatch(ctx: Context): Promise<string> {
|
||||
}
|
||||
|
||||
try {
|
||||
const tempDir = await createTempDir()
|
||||
const patchPath = path.join(tempDir, "pull.patch")
|
||||
const patchPath = await createTempDir().then((tempDir) => path.join(tempDir, "pull.patch"))
|
||||
core.info(`Writing patch to ${patchPath}`)
|
||||
await writeFile(patchPath, alterDiffPatch(patch))
|
||||
return patchPath
|
||||
@@ -108,8 +103,7 @@ async function fetchPushPatch(ctx: Context): Promise<string> {
|
||||
}
|
||||
|
||||
try {
|
||||
const tempDir = await createTempDir()
|
||||
const patchPath = path.join(tempDir, "push.patch")
|
||||
const patchPath = await createTempDir().then((tempDir) => path.join(tempDir, "push.patch"))
|
||||
core.info(`Writing patch to ${patchPath}`)
|
||||
await writeFile(patchPath, alterDiffPatch(patch))
|
||||
return patchPath
|
||||
|
||||
@@ -5,7 +5,7 @@ import * as path from "path"
|
||||
import { promisify } from "util"
|
||||
import YAML from "yaml"
|
||||
|
||||
const execShellCommand = promisify(exec)
|
||||
const execCommand = promisify(exec)
|
||||
|
||||
type ExecRes = {
|
||||
stdout: string
|
||||
@@ -34,12 +34,13 @@ export async function install(binPath: string): Promise<string> {
|
||||
rootDir = process.cwd()
|
||||
}
|
||||
|
||||
const configFile = [".custom-gcl.yml", ".custom-gcl.yaml", ".custom-gcl.json"]
|
||||
.map((v) => path.join(rootDir, v))
|
||||
const configFile = ["yml", "yaml", "json"]
|
||||
.map((ext) => `.custom-gcl.${ext}`)
|
||||
.map((filename) => path.join(rootDir, filename))
|
||||
.find((filePath) => fs.existsSync(filePath))
|
||||
|
||||
if (!configFile || configFile === "") {
|
||||
return ""
|
||||
return binPath
|
||||
}
|
||||
|
||||
core.info(`Found configuration for the plugin module system : ${configFile}`)
|
||||
@@ -53,7 +54,7 @@ export async function install(binPath: string): Promise<string> {
|
||||
const v: string = core.getInput(`version`)
|
||||
if (v !== "" && config.version !== v) {
|
||||
core.warning(
|
||||
`The golangci-lint version (${config.version}) defined inside in ${configFile} does not match the version defined in the action (${v})`
|
||||
`The golangci-lint version (${config.version}) defined inside ${configFile} does not match the version defined in the action (${v})`
|
||||
)
|
||||
}
|
||||
|
||||
@@ -73,18 +74,15 @@ export async function install(binPath: string): Promise<string> {
|
||||
|
||||
core.info(`Running [${cmd}] in [${rootDir}] ...`)
|
||||
|
||||
try {
|
||||
const options: ExecOptionsWithStringEncoding = {
|
||||
cwd: rootDir,
|
||||
}
|
||||
|
||||
const res = await execShellCommand(cmd, options)
|
||||
printOutput(res)
|
||||
|
||||
core.info(`Built custom golangci-lint binary in ${Date.now() - startedAt}ms`)
|
||||
|
||||
return path.join(rootDir, config.destination, config.name)
|
||||
} catch (exc) {
|
||||
throw new Error(`Failed to build custom golangci-lint binary: ${exc.message}`)
|
||||
const options: ExecOptionsWithStringEncoding = {
|
||||
cwd: rootDir,
|
||||
}
|
||||
|
||||
return execCommand(cmd, options)
|
||||
.then(printOutput)
|
||||
.then(() => core.info(`Built custom golangci-lint binary in ${Date.now() - startedAt}ms`))
|
||||
.then(() => path.join(rootDir, config.destination, config.name))
|
||||
.catch((exc) => {
|
||||
throw new Error(`Failed to build custom golangci-lint binary: ${exc.message}`)
|
||||
})
|
||||
}
|
||||
|
||||
171
src/run.ts
171
src/run.ts
@@ -10,37 +10,7 @@ import { install } from "./install"
|
||||
import { fetchPatch, isOnlyNewIssues } from "./patch"
|
||||
import * as plugins from "./plugins"
|
||||
|
||||
const execShellCommand = promisify(exec)
|
||||
|
||||
type Env = {
|
||||
binPath: string
|
||||
patchPath: string
|
||||
}
|
||||
|
||||
async function prepareEnv(installOnly: boolean): Promise<Env> {
|
||||
const startedAt = Date.now()
|
||||
|
||||
// Prepare cache, lint and go in parallel.
|
||||
await restoreCache()
|
||||
|
||||
let binPath = await install()
|
||||
|
||||
// Build custom golangci-lint if needed.
|
||||
const customBinPath = await plugins.install(binPath)
|
||||
if (customBinPath !== "") {
|
||||
binPath = customBinPath
|
||||
}
|
||||
|
||||
if (installOnly) {
|
||||
return { binPath, patchPath: `` }
|
||||
}
|
||||
|
||||
const patchPath = await fetchPatch()
|
||||
|
||||
core.info(`Prepared env in ${Date.now() - startedAt}ms`)
|
||||
|
||||
return { binPath, patchPath }
|
||||
}
|
||||
const execCommand = promisify(exec)
|
||||
|
||||
type ExecRes = {
|
||||
stdout: string
|
||||
@@ -56,13 +26,7 @@ const printOutput = (res: ExecRes): void => {
|
||||
}
|
||||
}
|
||||
|
||||
async function runLint(binPath: string, patchPath: string): Promise<void> {
|
||||
const debug = core.getInput(`debug`)
|
||||
if (debug.split(`,`).includes(`cache`)) {
|
||||
const res = await execShellCommand(`${binPath} cache status`)
|
||||
printOutput(res)
|
||||
}
|
||||
|
||||
async function runGolangciLint(binPath: string, rootDir: string): Promise<void> {
|
||||
const userArgs = core.getInput(`args`)
|
||||
const addedArgs: string[] = []
|
||||
|
||||
@@ -77,17 +41,6 @@ async function runLint(binPath: string, patchPath: string): Promise<void> {
|
||||
const userArgsMap = new Map<string, string>(userArgsList)
|
||||
const userArgNames = new Set<string>(userArgsList.map(([key]) => key))
|
||||
|
||||
const problemMatchers = core.getBooleanInput(`problem-matchers`)
|
||||
|
||||
if (problemMatchers) {
|
||||
const matchersPath = path.join(__dirname, "../..", "problem-matchers.json")
|
||||
if (fs.existsSync(matchersPath)) {
|
||||
// Adds problem matchers.
|
||||
// https://github.com/actions/setup-go/blob/cdcb36043654635271a94b9a6d1392de5bb323a7/src/main.ts#L81-L83
|
||||
core.info(`##[add-matcher]${matchersPath}`)
|
||||
}
|
||||
}
|
||||
|
||||
if (isOnlyNewIssues()) {
|
||||
if (
|
||||
userArgNames.has(`new`) ||
|
||||
@@ -99,6 +52,7 @@ async function runLint(binPath: string, patchPath: string): Promise<void> {
|
||||
}
|
||||
|
||||
const ctx = github.context
|
||||
const patchPath = await fetchPatch()
|
||||
|
||||
core.info(`only new issues on ${ctx.eventName}: ${patchPath}`)
|
||||
|
||||
@@ -130,17 +84,12 @@ async function runLint(binPath: string, patchPath: string): Promise<void> {
|
||||
|
||||
const cmdArgs: ExecOptionsWithStringEncoding = {}
|
||||
|
||||
const workingDirectory = core.getInput(`working-directory`)
|
||||
if (workingDirectory) {
|
||||
if (!fs.existsSync(workingDirectory) || !fs.lstatSync(workingDirectory).isDirectory()) {
|
||||
throw new Error(`working-directory (${workingDirectory}) was not a path`)
|
||||
}
|
||||
|
||||
if (rootDir) {
|
||||
if (!userArgNames.has(`path-prefix`) && !userArgNames.has(`path-mode`)) {
|
||||
addedArgs.push(`--path-mode=abs`)
|
||||
}
|
||||
|
||||
cmdArgs.cwd = path.resolve(workingDirectory)
|
||||
cmdArgs.cwd = path.resolve(rootDir)
|
||||
}
|
||||
|
||||
await runVerify(binPath, userArgsMap, cmdArgs)
|
||||
@@ -150,22 +99,21 @@ async function runLint(binPath: string, patchPath: string): Promise<void> {
|
||||
core.info(`Running [${cmd}] in [${cmdArgs.cwd || process.cwd()}] ...`)
|
||||
|
||||
const startedAt = Date.now()
|
||||
try {
|
||||
const res = await execShellCommand(cmd, cmdArgs)
|
||||
printOutput(res)
|
||||
core.info(`golangci-lint found no issues`)
|
||||
} catch (exc) {
|
||||
// This logging passes issues to GitHub annotations but comments can be more convenient for some users.
|
||||
printOutput(exc)
|
||||
|
||||
if (exc.code === 1) {
|
||||
core.setFailed(`issues found`)
|
||||
} else {
|
||||
core.setFailed(`golangci-lint exit with code ${exc.code}`)
|
||||
}
|
||||
}
|
||||
return execCommand(cmd, cmdArgs)
|
||||
.then(printOutput)
|
||||
.then(() => core.info(`golangci-lint found no issues`))
|
||||
.catch((exc) => {
|
||||
// This logging passes issues to GitHub annotations.
|
||||
printOutput(exc)
|
||||
|
||||
core.info(`Ran golangci-lint in ${Date.now() - startedAt}ms`)
|
||||
if (exc.code === 1) {
|
||||
core.setFailed(`issues found`)
|
||||
} else {
|
||||
core.setFailed(`golangci-lint exit with code ${exc.code}`)
|
||||
}
|
||||
})
|
||||
.finally(() => core.info(`Ran golangci-lint in ${Date.now() - startedAt}ms`))
|
||||
}
|
||||
|
||||
async function runVerify(binPath: string, userArgsMap: Map<string, string>, cmdArgs: ExecOptionsWithStringEncoding): Promise<void> {
|
||||
@@ -186,8 +134,7 @@ async function runVerify(binPath: string, userArgsMap: Map<string, string>, cmdA
|
||||
|
||||
core.info(`Running [${cmdVerify}] in [${cmdArgs.cwd || process.cwd()}] ...`)
|
||||
|
||||
const res = await execShellCommand(cmdVerify, cmdArgs)
|
||||
printOutput(res)
|
||||
await execCommand(cmdVerify, cmdArgs).then(printOutput)
|
||||
}
|
||||
|
||||
async function getConfigPath(binPath: string, userArgsMap: Map<string, string>, cmdArgs: ExecOptionsWithStringEncoding): Promise<string> {
|
||||
@@ -199,26 +146,98 @@ async function getConfigPath(binPath: string, userArgsMap: Map<string, string>,
|
||||
core.info(`Running [${cmdConfigPath}] in [${cmdArgs.cwd || process.cwd()}] ...`)
|
||||
|
||||
try {
|
||||
const resPath = await execShellCommand(cmdConfigPath, cmdArgs)
|
||||
const resPath = await execCommand(cmdConfigPath, cmdArgs)
|
||||
return resPath.stderr.trim()
|
||||
} catch {
|
||||
return ``
|
||||
}
|
||||
}
|
||||
|
||||
async function debugAction(binPath: string) {
|
||||
const flags = core.getInput(`debug`).split(`,`)
|
||||
|
||||
if (flags.includes(`clean`)) {
|
||||
const cmd = `${binPath} cache clean`
|
||||
|
||||
core.info(`Running [${cmd}] ...`)
|
||||
|
||||
await execCommand(cmd).then(printOutput)
|
||||
}
|
||||
|
||||
if (flags.includes(`cache`)) {
|
||||
const cmd = `${binPath} cache status`
|
||||
|
||||
core.info(`Running [${cmd}] ...`)
|
||||
|
||||
await execCommand(cmd).then(printOutput)
|
||||
}
|
||||
}
|
||||
|
||||
function getWorkingDirectory(): string {
|
||||
const workingDirectory = core.getInput(`working-directory`)
|
||||
if (workingDirectory) {
|
||||
if (!fs.existsSync(workingDirectory) || !fs.lstatSync(workingDirectory).isDirectory()) {
|
||||
throw new Error(`working-directory (${workingDirectory}) was not a path`)
|
||||
}
|
||||
}
|
||||
|
||||
return workingDirectory
|
||||
}
|
||||
|
||||
function modulesAutoDetection(rootDir: string): string[] {
|
||||
const o: fs.GlobOptions = {
|
||||
cwd: rootDir,
|
||||
exclude: ["**/vendor/**", "**/node_modules/**", "**/.git/**", "**/dist/**"],
|
||||
}
|
||||
|
||||
const matches = fs.globSync("**/go.mod", o)
|
||||
|
||||
const dirs = matches
|
||||
.filter((m) => typeof m === "string")
|
||||
.map((m) => path.resolve(rootDir, path.dirname(m)))
|
||||
.sort()
|
||||
|
||||
return [...new Set(dirs)]
|
||||
}
|
||||
|
||||
async function runLint(binPath: string): Promise<void> {
|
||||
const workingDirectory = getWorkingDirectory()
|
||||
|
||||
const experimental = core.getInput(`experimental`).split(`,`)
|
||||
|
||||
if (experimental.includes(`automatic-module-directories`)) {
|
||||
const wds = modulesAutoDetection(workingDirectory)
|
||||
|
||||
const cwd = process.cwd()
|
||||
|
||||
for (const wd of wds) {
|
||||
await core.group(`run golangci-lint in ${path.relative(cwd, wd)}`, () => runGolangciLint(binPath, wd))
|
||||
}
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
await core.group(`run golangci-lint`, () => runGolangciLint(binPath, workingDirectory))
|
||||
}
|
||||
|
||||
export async function run(): Promise<void> {
|
||||
try {
|
||||
const installOnly = core.getBooleanInput(`install-only`, { required: true })
|
||||
await core.group(`Restore cache`, restoreCache)
|
||||
|
||||
const { binPath, patchPath } = await core.group(`prepare environment`, () => prepareEnv(installOnly))
|
||||
const binPath = await core.group(`Install`, () => install().then(plugins.install))
|
||||
|
||||
core.addPath(path.dirname(binPath))
|
||||
|
||||
if (core.getInput(`debug`)) {
|
||||
await core.group(`Debug`, () => debugAction(binPath))
|
||||
}
|
||||
|
||||
const installOnly = core.getBooleanInput(`install-only`, { required: true })
|
||||
if (installOnly) {
|
||||
return
|
||||
}
|
||||
|
||||
await core.group(`run golangci-lint`, () => runLint(binPath, patchPath))
|
||||
await runLint(binPath)
|
||||
} catch (error) {
|
||||
core.error(`Failed to run: ${error}, ${error.stack}`)
|
||||
core.setFailed(error.message)
|
||||
|
||||
@@ -67,6 +67,12 @@ const isLessVersion = (a: Version, b: Version): boolean => {
|
||||
|
||||
const getRequestedVersion = (): Version => {
|
||||
let requestedVersion = core.getInput(`version`)
|
||||
let versionFilePath = core.getInput(`version-file`)
|
||||
|
||||
if (requestedVersion && versionFilePath) {
|
||||
core.warning(`Both version (${requestedVersion}) and version-file (${versionFilePath}) inputs are specified, only version will be used`)
|
||||
}
|
||||
|
||||
const workingDirectory = core.getInput(`working-directory`)
|
||||
|
||||
let goMod = "go.mod"
|
||||
@@ -83,6 +89,27 @@ const getRequestedVersion = (): Version => {
|
||||
}
|
||||
}
|
||||
|
||||
if (requestedVersion == "" && versionFilePath) {
|
||||
if (workingDirectory) {
|
||||
versionFilePath = path.join(workingDirectory, versionFilePath)
|
||||
}
|
||||
|
||||
if (!fs.existsSync(versionFilePath)) {
|
||||
throw new Error(`The specified golangci-lint version file at: ${versionFilePath} does not exist`)
|
||||
}
|
||||
|
||||
const content = fs.readFileSync(versionFilePath, "utf-8")
|
||||
|
||||
if (path.basename(versionFilePath) === ".tool-versions") {
|
||||
// asdf/mise file.
|
||||
const match = content.match(/^golangci-lint\s+([^\n#]+)/m)
|
||||
requestedVersion = match ? "v" + match[1].trim().replace(/^v/gi, "") : ""
|
||||
} else {
|
||||
// .golangci-lint-version file.
|
||||
requestedVersion = "v" + content.trim().replace(/^v/gi, "")
|
||||
}
|
||||
}
|
||||
|
||||
const parsedRequestedVersion = parseVersion(requestedVersion)
|
||||
if (parsedRequestedVersion == null) {
|
||||
return null
|
||||
|
||||
Reference in New Issue
Block a user