Skip to content
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

Improve pre-commit UX #5320

Merged
merged 2 commits into from
Dec 10, 2024
Merged

Improve pre-commit UX #5320

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b596029
Add default stages/install hook type to pre-commit
bryan-cox Dec 4, 2024
b33199c
Add make verify/test to pre-push pre-commit config
bryan-cox Dec 4, 2024
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
43 changes: 42 additions & 1 deletion .pre-commit-config.yaml
View file
Open in desktop
bryan-cox marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
@@ -1,25 +1,66 @@
default_stages: [pre-commit, pre-push]
default_install_hook_types: [pre-commit, pre-push]
repos:
- repo: https://github.com/gitleaks/gitleaks
rev: v8.21.1
hooks:
- id: gitleaks
stages: [pre-commit]
- repo: https://github.com/koalaman/shellcheck-precommit
rev: v0.10.0
hooks:
- id: shellcheck
args: ["--external-sources"]
stages: [pre-commit]
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v5.0.0
hooks:
- id: end-of-file-fixer
stages: [pre-commit]
- id: trailing-whitespace
stages: [pre-commit]
- id: detect-private-key
stages: [pre-commit]
- repo: https://github.com/pylint-dev/pylint
rev: v3.3.1
hooks:
- id: pylint
exclude: ^hack/boilerplate/boilerplate.py$
stages: [pre-commit]
- repo: https://github.com/jumanjihouse/pre-commit-hooks
rev: 3.0.0
hooks:
- id: forbid-binary
- id: forbid-binary
stages: [pre-commit]
- repo: local
hooks:
- id: make-modules
name: Run make verify-modules
entry: make verify-modules
language: system
stages: [pre-push]
- id: make-gen
name: Run make verify-gen
entry: make verify-gen
language: system
stages: [pre-push]
- id: make-spellcheck
name: Run make verify-shellcheck
entry: make verify-shellcheck
language: system
stages: [ pre-push ]
Copy link
Member

Choose a reason for hiding this comment

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

I am not sure if [ pre-push ] is any different to [pre-push] (extra space padding being added to pre-push string).

Could please paste sample output of using this .pre-commit.config in the PR description or as a comment?

This looks great to me btw!
/lgtm

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I added some example output to the PR description

- id: make-conversions
name: Run make verify-conversions
entry: make verify-conversions
language: system
stages: [ pre-push ]
- id: make-tiltfile
name: Run make verify-tiltfile
entry: make verify-tiltfile
language: system
stages: [ pre-push ]
- id: make-test
name: Run make test
entry: make test
language: system
stages: [pre-push]
Loading