confine pre-commit to stages

[davidculley]

Description

See https://pre-commit.com/#confining-hooks-to-run-at-certain-stages

If you are authoring a tool, it is usually a good idea to provide an appropriate stages property. For example a reasonable setting for a linter or code formatter would be stages: [pre-commit, pre-merge-commit, pre-push, manual].

Checklist - did you ...

• Add an entry in CHANGES.md if necessary?
• Add / update tests if necessary?
• Add new / update outdated documentation?

[JelleZijlstra]

Thanks. Could you add a changelog entry since this changes user-visible behavior?

[davidculley]

Thanks. Could you add a changelog entry since this changes user-visible behavior?

Done. It seems now that, for some reason, the documentation cannot be generated for the Windows build.

[Stiffler911]

Thanks. Could you add a changelog entry since this changes user-visible behavior?

Done. It seems now that, for some reason, the documentation cannot be generated for the Windows build.

Why does this happen?

[JelleZijlstra]

Some bug that we didn't figure out. Apparently it's fixed now, let me retrigger CI.

[davidculley]

Thanks for your help @JelleZijlstra 🙂

[martin-thoma]

When I now try to commit, I get:

pre_commit.clientlib.InvalidManifestError: 
==> File /home/martin/.cache/pre-commit/repolc31_gpb/.pre-commit-hooks.yaml
==> At Hook(id='black')
==> At key: stages
==> At index 0
=====> Expected one of commit, commit-msg, manual, merge-commit, post-checkout, post-commit, post-merge, post-rewrite, prepare-commit-msg, push but got: 'pre-commit'

reverting to 23.10.1 solves the issue for me.

edit: I think I'll open an issue.

[davidculley]

When I now try to commit, I get:

pre_commit.clientlib.InvalidManifestError: 
==> File /home/martin/.cache/pre-commit/repolc31_gpb/.pre-commit-hooks.yaml
==> At Hook(id='black')
==> At key: stages
==> At index 0
=====> Expected one of commit, commit-msg, manual, merge-commit, post-checkout, post-commit, post-merge, post-rewrite, prepare-commit-msg, push but got: 'pre-commit'

reverting to 23.10.1 solves the issue for me.

edit: I think I'll open an issue.

@MT-Cash: This should be fixed by upgrading pre-commit:

pip install --upgrade pre-commit

I think you need to use pre-commit 3.2.0 or newer. See https://github.com/pre-commit/pre-commit/releases/tag/v3.2.0

Or here:

new in 3.2.0: The values of stages match the hook names. Previously, commit, push, and merge-commit matched pre-commit, pre-push, and pre-merge-commit respectively.