diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index c1d67c37a02..d9054838b8e 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -43,24 +43,29 @@ repos: name: Run make verify-gen entry: make verify-gen language: system - stages: [pre-push] + stages: [ pre-push ] - id: make-spellcheck name: Run make verify-shellcheck entry: make verify-shellcheck language: system - stages: [ pre-push ] + stages: [pre-push] - id: make-conversions name: Run make verify-conversions entry: make verify-conversions language: system - stages: [ pre-push ] + stages: [pre-push] - id: make-tiltfile name: Run make verify-tiltfile entry: make verify-tiltfile language: system - stages: [ pre-push ] + stages: [pre-push] - id: make-test - name: Run make test - entry: make test + name: Run make go-test-race + entry: make go-test-race language: system stages: [pre-push] + - id: make-lint + name: Run make lint + entry: make lint + language: system + stages: [ pre-push ] diff --git a/docs/book/src/developers/development.md b/docs/book/src/developers/development.md index df2a43055e9..9d940f9ed20 100644 --- a/docs/book/src/developers/development.md +++ b/docs/book/src/developers/development.md @@ -75,6 +75,7 @@ 10. Install [pre-commit framework](https://pre-commit.com/#installation) - `brew install pre-commit` Or `pip install pre-commit`. Installs pre-commit globally. - run `pre-commit install` at the root of the project to install pre-commit hooks to read `.pre-commit-config.yaml` + - run `pre-commit install --hook-type pre-push` to install pre-push hooks. - *Note*: use `git commit --no-verify` to skip running pre-commit workflow as and when needed. When developing on Windows, it is suggested to set up the project on Windows + WSL2 and the file should be checked out on as wsl file system for better results.