make stages and hook-type match
#2732
Labels
Comments
This was referenced Mar 7, 2023
jaypikay
pushed a commit
to jaypikay/doxy
that referenced
this issue
Apr 27, 2023
This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [pre-commit](https://github.com/pre-commit/pre-commit) | dev-dependencies | major | `^2.21.0` -> `^3.0.0` | --- ### Release Notes <details> <summary>pre-commit/pre-commit</summary> ### [`v3.2.2`](https://github.com/pre-commit/pre-commit/blob/HEAD/CHANGELOG.md#​322---2023-04-03) [Compare Source](pre-commit/pre-commit@v3.2.1...v3.2.2) \================== ##### Fixes - Fix support for swift >= 5.8. - [#​2836](pre-commit/pre-commit#2836) PR by [@​edelabar](https://github.com/edelabar). - [#​2835](pre-commit/pre-commit#2835) issue by [@​kgrobelny-intive](https://github.com/kgrobelny-intive). ### [`v3.2.1`](https://github.com/pre-commit/pre-commit/blob/HEAD/CHANGELOG.md#​321---2023-03-25) [Compare Source](pre-commit/pre-commit@v3.2.0...v3.2.1) \================== ##### Fixes - Fix `language_version` for `language: rust` without global `rustup`. - [#​2823](pre-commit/pre-commit#2823) issue by [@​daschuer](https://github.com/daschuer). - [#​2827](pre-commit/pre-commit#2827) PR by [@​asottile](https://github.com/asottile). ### [`v3.2.0`](https://github.com/pre-commit/pre-commit/blob/HEAD/CHANGELOG.md#​320---2023-03-17) [Compare Source](pre-commit/pre-commit@v3.1.1...v3.2.0) \================== ##### Features - Allow `pre-commit`, `pre-push`, and `pre-merge-commit` as `stages`. - [#​2732](pre-commit/pre-commit#2732) issue by [@​asottile](https://github.com/asottile). - [#​2808](pre-commit/pre-commit#2808) PR by [@​asottile](https://github.com/asottile). - Add `pre-rebase` hook support. - [#​2582](pre-commit/pre-commit#2582) issue by [@​BrutalSimplicity](https://github.com/BrutalSimplicity). - [#​2725](pre-commit/pre-commit#2725) PR by [@​mgaligniana](https://github.com/mgaligniana). ##### Fixes - Remove bulky cargo cache from `language: rust` installs. - [#​2820](pre-commit/pre-commit#2820) PR by [@​asottile](https://github.com/asottile). ### [`v3.1.1`](https://github.com/pre-commit/pre-commit/blob/HEAD/CHANGELOG.md#​311---2023-02-27) [Compare Source](pre-commit/pre-commit@v3.1.0...v3.1.1) \================== ##### Fixes - Fix `rust` with `language_version` and a non-writable host `RUSTUP_HOME`. - [pre-commit-ci/issues#​173](pre-commit-ci/issues#173) by [@​Swiftb0y](https://github.com/Swiftb0y). - [#​2788](pre-commit/pre-commit#2788) by [@​asottile](https://github.com/asottile). ### [`v3.1.0`](https://github.com/pre-commit/pre-commit/blob/HEAD/CHANGELOG.md#​310---2023-02-22) [Compare Source](pre-commit/pre-commit@v3.0.4...v3.1.0) \================== ##### Fixes - Fix `dotnet` for `.sln`-based hooks for dotnet>=7.0.200. - [#​2763](pre-commit/pre-commit#2763) PR by [@​m-rsha](https://github.com/m-rsha). - Prevent stashing when `diff` fails to execute. - [#​2774](pre-commit/pre-commit#2774) PR by [@​asottile](https://github.com/asottile). - [#​2773](pre-commit/pre-commit#2773) issue by [@​strubbly](https://github.com/strubbly). - Dependencies are no longer sorted in repository key. - [#​2776](pre-commit/pre-commit#2776) PR by [@​asottile](https://github.com/asottile). ##### Updating - Deprecate `language: python_venv`. Use `language: python` instead. - [#​2746](pre-commit/pre-commit#2746) PR by [@​asottile](https://github.com/asottile). - [#​2734](pre-commit/pre-commit#2734) issue by [@​asottile](https://github.com/asottile). ### [`v3.0.4`](https://github.com/pre-commit/pre-commit/blob/HEAD/CHANGELOG.md#​304---2023-02-03) [Compare Source](pre-commit/pre-commit@v3.0.3...v3.0.4) \================== ##### Fixes - Fix hook diff detection for files affected by `--textconv`. - [#​2743](pre-commit/pre-commit#2743) PR by [@​adamchainz](https://github.com/adamchainz). - [#​2743](pre-commit/pre-commit#2743) issue by [@​adamchainz](https://github.com/adamchainz). ### [`v3.0.3`](https://github.com/pre-commit/pre-commit/blob/HEAD/CHANGELOG.md#​303---2023-02-01) [Compare Source](pre-commit/pre-commit@v3.0.2...v3.0.3) \================== ##### Fixes - Revert "Prevent local `Gemfile` from interfering with hook execution.". - [#​2739](pre-commit/pre-commit#2739) issue by [@​Roguelazer](https://github.com/Roguelazer). - [#​2740](pre-commit/pre-commit#2740) PR by [@​asottile](https://github.com/asottile). ### [`v3.0.2`](https://github.com/pre-commit/pre-commit/blob/HEAD/CHANGELOG.md#​302---2023-01-29) [Compare Source](pre-commit/pre-commit@v3.0.1...v3.0.2) \================== ##### Fixes - Prevent local `Gemfile` from interfering with hook execution. - [#​2727](pre-commit/pre-commit#2727) PR by [@​asottile](https://github.com/asottile). - Fix `language: r`, `repo: local` hooks - [pre-commit-ci/issues#​107](pre-commit-ci/issues#107) by [@​lorenzwalthert](https://github.com/lorenzwalthert). - [#​2728](pre-commit/pre-commit#2728) PR by [@​asottile](https://github.com/asottile). ### [`v3.0.1`](https://github.com/pre-commit/pre-commit/blob/HEAD/CHANGELOG.md#​301---2023-01-26) [Compare Source](pre-commit/pre-commit@v3.0.0...v3.0.1) \================== ##### Fixes - Ensure coursier hooks are available offline after install. - [#​2723](pre-commit/pre-commit#2723) PR by [@​asottile](https://github.com/asottile). ### [`v3.0.0`](https://github.com/pre-commit/pre-commit/blob/HEAD/CHANGELOG.md#​300---2023-01-23) [Compare Source](pre-commit/pre-commit@v2.21.0...v3.0.0) \================== ##### Features - Make `language: golang` bootstrap `go` if not present. - [#​2651](pre-commit/pre-commit#2651) PR by [@​taoufik07](https://github.com/taoufik07). - [#​2649](pre-commit/pre-commit#2649) issue by [@​taoufik07](https://github.com/taoufik07). - `language: coursier` now supports `additional_dependencies` and `repo: local` - [#​2702](pre-commit/pre-commit#2702) PR by [@​asottile](https://github.com/asottile). - Upgrade `ruby-build` to `20221225`. - [#​2718](pre-commit/pre-commit#2718) PR by [@​jalessio](https://github.com/jalessio). ##### Fixes - Improve error message for invalid yaml for `pre-commit autoupdate`. - [#​2686](pre-commit/pre-commit#2686) PR by [@​asottile](https://github.com/asottile). - [#​2685](pre-commit/pre-commit#2685) issue by [@​CarstenGrohmann](https://github.com/CarstenGrohmann). - `repo: local` no longer provisions an empty `git` repo. - [#​2699](pre-commit/pre-commit#2699) PR by [@​asottile](https://github.com/asottile). ##### Updating - Drop support for python<3.8 - [#​2655](pre-commit/pre-commit#2655) PR by [@​asottile](https://github.com/asottile). - Drop support for top-level list, use `pre-commit migrate-config` to update. - [#​2656](pre-commit/pre-commit#2656) PR by [@​asottile](https://github.com/asottile). - Drop support for `sha` to specify revision, use `pre-commit migrate-config` to update. - [#​2657](pre-commit/pre-commit#2657) PR by [@​asottile](https://github.com/asottile). - Remove `pre-commit-validate-config` and `pre-commit-validate-manifest`, use `pre-commit validate-config` and `pre-commit validate-manifest` instead. - [#​2658](pre-commit/pre-commit#2658) PR by [@​asottile](https://github.com/asottile). - `language: golang` hooks must use `go.mod` to specify dependencies - [#​2672](pre-commit/pre-commit#2672) PR by [@​taoufik07](https://github.com/taoufik07). </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNS42MS4wIiwidXBkYXRlZEluVmVyIjoiMzUuNjEuMCJ9--> Co-authored-by: Renovate Bot <renovate@localhost.localdomain> Reviewed-on: https://git.goatpr0n.de/public/doxy/pulls/2 Co-authored-by: renovate <renovate@noreply.localhost> Co-committed-by: renovate <renovate@noreply.localhost>
3 tasks
espressif-bot
pushed a commit
to espressif/esp-idf
that referenced
this issue
Dec 29, 2023
With b93cc58 ("fix: set default pre-commit hook stages to pre-commit..") a dependency on pre-commit 3.3 was added. As it turned out, there are people still using e.g. 2.16 version and this change is causing problems. 1. The minimum_pre_commit_version is checked after the config is parsed. Meaning if there is a problem in the config file, like unknown pre-commit for default_stages, pre-commit exits with an error not suggesting that it should be updated. 2. "pre-commit" was added in 3.2 for consistency with git hook names and we can use "commit" instead avoiding dependency on newer pre-commit. For more info please see [1] and [2]. 3. default_install_hook_types[4] were added in 2.18.0[3]. This was IMHO actually a nice feature to have in our .pre-commit-config.yaml, because it specifies which hooks should be installed when pre-commit install is executed. Meaning it's not necessary to list the stages explicitly with the -t options. Anyway we haven't used this feature till now, so it hopefully should not be a problem if we remove it again. With this change we can still avoid to start pre-commit plugins multiple times for different stages, but also make it compatible with older versions(2.16). [1] pre-commit/pre-commit#2732 [2] pre-commit/pre-commit#2808 [3] https://github.com/pre-commit/pre-commit/blob/main/CHANGELOG.md#2180---2022-04-02 [4] https://pre-commit.com/#top_level-default_install_hook_types Fixes: b93cc58 ("fix: set default pre-commit hook stages to pre-commit..") Signed-off-by: Frantisek Hrbata <frantisek.hrbata@espressif.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
and others
this is mostly a confusion point / slightly annoying and a mistake I made when first introducing new hook types
currently all of the
--hook-typeandstagesvalues match except for these three:pre-commit:commitpre-merge-commit:merge-commitpre-push:pushI'd like to deprecate the mismatched names!
this is going to need a long deprecation period since it's sorta subtle and usually not the user's fault and will need hook authors to (potentially) make updates
the plan is to do the following:
migrate-configwill autofix.pre-commit-config.yamlusages ofstageswith the old values (there isn't an equivalentmigrate-manifest-- though users outnumber hook authors by several orders of magnitude)stagesnamesstagesnames (do this at install time so it only shows once as to not be super annoying for users who have no control)minimum_pre_commit_versionto this versionThe text was updated successfully, but these errors were encountered: