Skip to content

chore(ci): goheader linting only runs in CI on changed or new files #100

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jan 8, 2025
Merged

chore(ci): goheader linting only runs in CI on changed or new files #100

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fb5608d
chore(lint): only run linter on new files
qdm12 Jan 3, 2025
eb45e9e
Use `MOD-YEAR-RANGE` instead of `MOD-YEAR`
qdm12 Jan 6, 2025
2833156
Only run goheader in CI not locally
qdm12 Jan 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .github/workflows/golangci-lint.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,10 @@ on:
workflow_dispatch:

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

jobs:
golangci:
Expand All @@ -23,3 +26,5 @@ jobs:
uses: golangci/golangci-lint-action@v6
with:
version: v1.60
only-new-issues: true
args: --enable goheader
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add a comment explaining why this is "manually" enabled via flag instead of in the config.

1 change: 0 additions & 1 deletion .golangci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ linters:
- gci
- gocheckcompilerdirectives
- gofmt
- goheader
- goimports
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add either:

  1. A comment where goheader would have been, pointing readers to the workflow config; or
  2. Copy the comment from the workflow config to here (with modification if necessary).

(1) feels better but I'm ok with the redundancy of 2 because this isn't depended on by any code / requires devs to read it regularly.

- gomodguard
- gosec
Expand Down
2 changes: 1 addition & 1 deletion .libevm-header
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright {{ MOD-YEAR }} the libevm authors.
Copyright {{ MOD-YEAR-RANGE }} the libevm authors.

The libevm additions to go-ethereum are free software: you can redistribute
them and/or modify them under the terms of the GNU Lesser General Public License
Expand Down
Loading