This is an automated email from the ASF dual-hosted git repository. maximebeauchemin pushed a commit to branch pre-commit-docs in repository https://gitbox.apache.org/repos/asf/superset.git
commit 4aa5815aff5337f7b6df549bad4044e7fab162ff Author: Maxime Beauchemin <[email protected]> AuthorDate: Mon Aug 19 17:00:12 2024 -0700 docs: improve pre-commit docs and discoverability when CI fails --- .github/workflows/pre-commit.yml | 7 +++--- docs/docs/contributing/development.mdx | 45 +++++++++++++++++++++++++++++++++- 2 files changed, 48 insertions(+), 4 deletions(-) diff --git a/.github/workflows/pre-commit.yml b/.github/workflows/pre-commit.yml index 80afdd708b..70b8190378 100644 --- a/.github/workflows/pre-commit.yml +++ b/.github/workflows/pre-commit.yml @@ -40,8 +40,9 @@ jobs: brew install norwoodj/tap/helm-docs - name: pre-commit run: | - if ! pre-commit run --all-files; then - git status - git diff + if ! pre-commit run --all-files || git diff --quiet --exit-code; then + echo "⚠️ Pre-commit check failed." + echo "To prevent/address this CI issue, please install/use pre-commit locally." + echo "Details here: https://superset.apache.org/docs/contributing/development#git-hooks"; exit 1 fi diff --git a/docs/docs/contributing/development.mdx b/docs/docs/contributing/development.mdx index 900b62efb0..f674e44378 100644 --- a/docs/docs/contributing/development.mdx +++ b/docs/docs/contributing/development.mdx @@ -92,7 +92,50 @@ To install run the following: pre-commit install ``` -A series of checks will now run when you make a git commit. +This will install the hooks in your local repository. From now on, a series of checks will +automatically run whenever you make a Git commit. + +#### Running Pre-commit Manually + +You can also run the pre-commit checks manually in various ways: + +- **Run pre-commit on all files (same as CI):** + + To run the pre-commit checks across all files in your repository, use the following command: + + ```bash + pre-commit run --all-files + ``` + + This is the same set of checks that will run during CI, ensuring your changes meet the project's standards. + +- **Run pre-commit on a specific file:** + + If you want to check or fix a specific file, you can do so by specifying the file path: + + ```bash + pre-commit run --files path/to/your/file.py + ``` + + This will only run the checks on the file(s) you specify. + +- **Run a specific pre-commit check:** + + To run a specific check (hook) across all files or a particular file, use the following command: + + ```bash + pre-commit run <hook_id> --all-files + ``` + + Or for a specific file: + + ```bash + pre-commit run <hook_id> --files path/to/your/file.py + ``` + + Replace `<hook_id>` with the ID of the specific hook you want to run. You can find the list + of available hooks in the `.pre-commit-config.yaml` file. + ## Alternatives to docker-compose
