-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(ci): add golangci-lint config and shared workflow
This adds a shared workflow for linting Go code using golangci-lint. It adds golangci-lint configuration files for both the default and soft linting configurations and clones the meta repository to use the configuration files when running the workflow.
- Loading branch information
1 parent
117014e
commit 638c967
Showing
3 changed files
with
137 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
name: lint | ||
on: | ||
workflow_call: | ||
inputs: | ||
working-directory: | ||
required: false | ||
type: string | ||
|
||
permissions: | ||
# Required: allow read access to the content for analysis. | ||
contents: read | ||
# Optional: allow read access to pull request. Use with `only-new-issues` option. | ||
pull-requests: read | ||
# Optional: allow write access to checks to allow the action to annotate code in the PR. | ||
checks: write | ||
|
||
jobs: | ||
lint: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Install Go | ||
uses: actions/setup-go@v5 | ||
with: | ||
go-version: stable | ||
- uses: actions/checkout@v4 | ||
- uses: actions/checkout@v4 | ||
with: | ||
repository: charmbracelet/meta | ||
path: meta | ||
- run: | | ||
pwd | ||
tree | ||
- name: golangci-lint | ||
uses: golangci/golangci-lint-action@v6 | ||
with: | ||
working-directory: ${{ inputs.working-directory }} | ||
# Optional: golangci-lint command line arguments. | ||
args: --config="$GITHUB_WORKSPACE/meta/golangci.yml" | ||
# Optional: show only new issues if it's a pull request. The default value is `false`. | ||
only-new-issues: true | ||
|
||
lint-soft: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Install Go | ||
uses: actions/setup-go@v5 | ||
with: | ||
go-version: stable | ||
- uses: actions/checkout@v4 | ||
- uses: actions/checkout@v4 | ||
with: | ||
repository: charmbracelet/meta | ||
path: meta | ||
- name: golangci-lint | ||
uses: golangci/golangci-lint-action@v6 | ||
with: | ||
working-directory: ${{ inputs.working-directory }} | ||
# Optional: golangci-lint command line arguments. | ||
args: --config="$GITHUB_WORKSPACE/meta/golangci-soft.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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
run: | ||
tests: false | ||
|
||
issues: | ||
include: | ||
- EXC0001 | ||
- EXC0005 | ||
- EXC0011 | ||
- EXC0012 | ||
- EXC0013 | ||
|
||
max-issues-per-linter: 0 | ||
max-same-issues: 0 | ||
|
||
linters: | ||
enable: | ||
# - dupl | ||
- exhaustive | ||
# - exhaustivestruct | ||
- goconst | ||
- godot | ||
- godox | ||
- gomnd | ||
- gomoddirectives | ||
- goprintffuncname | ||
# - lll | ||
- misspell | ||
- nakedret | ||
- nestif | ||
- noctx | ||
- nolintlint | ||
- prealloc | ||
- wrapcheck | ||
|
||
# disable default linters, they are already enabled in .golangci.yml | ||
disable: | ||
- deadcode | ||
- errcheck | ||
- gosimple | ||
- govet | ||
- ineffassign | ||
- staticcheck | ||
- structcheck | ||
- typecheck | ||
- unused | ||
- varcheck |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
run: | ||
tests: false | ||
|
||
issues: | ||
include: | ||
- EXC0001 | ||
- EXC0005 | ||
- EXC0011 | ||
- EXC0012 | ||
- EXC0013 | ||
|
||
max-issues-per-linter: 0 | ||
max-same-issues: 0 | ||
|
||
linters: | ||
enable: | ||
- bodyclose | ||
- exportloopref | ||
- gofumpt | ||
- goimports | ||
- gosec | ||
- nilerr | ||
- predeclared | ||
- revive | ||
- rowserrcheck | ||
- sqlclosecheck | ||
- tparallel | ||
- unconvert | ||
- unparam | ||
- whitespace |