build: integrate pre-commit hooks with upstream files filtering support #1121
+673
−191
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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,96 @@ | ||
| # Usage: | ||
| # 1) Install the hooks: | ||
| # pre-commit install && pre-commit install --hook-type pre-push | ||
| # 2) [Optional] Run the hooks on demand before committing: | ||
| # pre-commit run --all-files | ||
| # 3) [Optional] Run the hooks on demand before pushing changes: | ||
| # pre-commit run --hook-stage pre-push --all-files | ||
| # | ||
| # NOTE: 2) and 3) are only needed to run the hooks manually. | ||
| # The hooks are automatically run by git when committing or pushing changes. | ||
| # | ||
| # If you want to temporarily disable the hooks without uninstalling them, you can use: | ||
| # git commit --no-verify | ||
| # git push --no-verify | ||
| # | ||
| # If you want to uninstall the hooks, you can use: | ||
| # pre-commit uninstall | ||
| # | ||
| # If you want to re-install the hooks, you can run 1) again. | ||
|
|
||
| minimum_pre_commit_version: "3.6.0" | ||
|
|
||
| repos: | ||
| # Fast feedback at commit time: baseline golangci-lint (v1) | ||
| - repo: https://github.com/golangci/golangci-lint | ||
| rev: v1.63.4 | ||
| hooks: | ||
| - id: golangci-lint | ||
| name: golangci-lint (baseline) | ||
| args: ["--config=.golangci.yml"] | ||
| stages: [pre-commit] | ||
|
|
||
| # Local utility scripts and full repo checks | ||
| - repo: local | ||
| hooks: | ||
| # Stricter extra lints (golangci-lint v2) on staged changes at pre-commit | ||
| - id: extra-golangci-lint | ||
| name: golangci-lint (extra via scripts/lint.sh) | ||
| entry: bash -lc 'TESTS="avalanche_golangci_lint" scripts/lint.sh' | ||
| language: system | ||
| stages: [pre-commit] | ||
| pass_filenames: false | ||
|
|
||
| - id: actionlint | ||
| name: actionlint | ||
| entry: scripts/actionlint.sh | ||
| language: system | ||
| files: ^\.github/workflows/.*\.(yml|yaml)$ | ||
| stages: [pre-commit] | ||
| pass_filenames: false | ||
|
|
||
| - id: shellcheck | ||
| name: shellcheck | ||
| entry: scripts/shellcheck.sh | ||
| language: system | ||
| files: \.sh$ | ||
| stages: [pre-commit] | ||
| pass_filenames: false | ||
|
|
||
| # General purpose housekeeping hooks | ||
| - repo: https://github.com/pre-commit/pre-commit-hooks | ||
powerslider marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| rev: v6.0.0 | ||
| hooks: | ||
| - id: trailing-whitespace | ||
| name: trailing-whitespace (filtered) | ||
| entry: scripts/filter_precommit_files.sh trailing-whitespace-fixer -- | ||
| pass_filenames: true | ||
| args: [--markdown-linebreak-ext=md] | ||
| - id: end-of-file-fixer | ||
| name: end-of-file-fixer (filtered) | ||
| entry: scripts/filter_precommit_files.sh end-of-file-fixer -- | ||
| pass_filenames: true | ||
| - id: check-merge-conflict | ||
| - id: check-yaml | ||
| name: check-yaml (filtered) | ||
| entry: scripts/filter_precommit_files.sh check-yaml -- | ||
| pass_filenames: true | ||
| - id: check-toml | ||
| name: check-toml (filtered) | ||
| entry: scripts/filter_precommit_files.sh check-toml -- | ||
| pass_filenames: true | ||
| - id: check-json | ||
| name: check-json (filtered) | ||
| entry: scripts/filter_precommit_files.sh check-json -- | ||
| pass_filenames: true | ||
| # Exclude intentionally invalid JSON fixtures used by tests | ||
| exclude: ^rpc/testdata/invalid-.*\.json$ | ||
|
|
||
| # Markdown formatter | ||
| - repo: https://github.com/hukkin/mdformat | ||
|
There was a problem hiding this comment. What's standard here? I'm not sure if we want to make these changes just for the pre-commit hooks (added arbitrarily) if we're not also going to lint for them There was a problem hiding this comment. This is the style guide it follows https://mdformat.readthedocs.io/en/stable/users/style.html There was a problem hiding this comment. I agree with @alarso16 re aligning pre-commit and linter checks. IMO the pre-commit is the fast-fail while the linter is the gatekeeper. |
||
| rev: 0.7.22 | ||
| hooks: | ||
| - id: mdformat | ||
| additional_dependencies: | ||
| - mdformat-gfm==0.4.1 | ||
| - mdformat-frontmatter==2.0.8 | ||
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
(fyi) I'm not reviewing this file, on the assumption that it's only formatting. Please let me know if that's an incorrect assumption.