Merge autopkgtest-cloud:pre-commit-changes into autopkgtest-cloud:master

[Brian Murray]

Using pre-commit run failed for me multiple times due to the naming of some of the stages - which looks like changed upstream (see new in 3.2.0 at https://pre-commit.com/#confining-hooks-to-run-at-certain-stages).

 $ pre-commit run
An error has occurred: InvalidConfigError:
==> File .pre-commit-config.yaml
==> At Config()
==> At key: repos
==> At Repository(repo='local')
==> At key: hooks
==> At Hook(id='pylint')
==> At key: stages
==> At index 5
=====> 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'
Check the log at /home/bdmurray/.cache/pre-commit/pre-commit.log

These changes allow pre-commit run to work for me locally. I'm not sure what will happen in Launchpad CI though.

[Tim Andersson (andersson123)]

Looks like it's good in CI to me. LGTM but let's wait for Paride as he is the pre-commit wizard

[Paride Legovini (paride)]

I'm slightly surprised as I thought I already used the new names. Checking...

[Paride Legovini (paride)]

My understanding of:

  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.

is that the new names are those with the pre-*.

Which version of pre-commit is failing for you?

review: Needs Information

[Brian Murray (brian-murray)]

On Thu, Aug 24, 2023 at 03:06:53PM -0000, Paride Legovini wrote:
> Review: Needs Information
>
> My understanding of:
>
> 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.
>
> is that the new names are those with the pre-*.
>
> Which version of pre-commit is failing for you?

Ah, I'd misread which was new and old. I'm using `pre-commit version:
3.0.4` which is the version available as a .deb in Ubuntu 23.04.

--
Brian Murray

[Paride Legovini (paride)]

Given that newer pre-commit versions do not issue warnings when using the old stage names, and that this just works in CI, I'm fine with this diff. Or just upgrade to Mantic :-)

review: Approve

[Brian Murray (brian-murray)]

You never know what release a potential contributor might be running so let's use the stage names which work on the greatest number of releases.

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index d3bc39f..56403eb 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -31,8 +31,7 @@ repos:
         name: pylint
         stages:
           [commit-msg, post-checkout, post-commit, post-merge, post-rewrite,
-           pre-commit, pre-merge-commit, pre-push, pre-rebase,
-           prepare-commit-msg]
+           commit, merge-commit, push, prepare-commit-msg]
         entry: pylint
         args:
           - "--disable=import-error"