Move pre-commit GitHub action to pre-commit.ci

[tkoyama010]

Overview

Using pre-commit official GitHub action.
Move pre-commit GitHub action to pre-commit.ci.

Details

• pre-commit project has official GitHub Actions of run pre-commit.

[codecov]

Codecov Report

Merging #4263 (b5e4c08) into main (07dfc66) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #4263   +/-   ##
=======================================
  Coverage   95.77%   95.77%           
=======================================
  Files          97       97           
  Lines       20755    20755           
=======================================
  Hits        19879    19879           
  Misses        876      876           

[akaszynski]

The action website states:

generally you want to use pre-commit.ciwhich is faster and has more features.

I think we decided to not go with that because we didn't want to have it modify the files independently. I'm actually fine if we decide to have the CI action modify our source. I've seen this implemented in other repos and have yet to see issues arise.

[banesullivan]

actually fine if we decide to have the CI action modify our source

I'd like to push back against that. If implemented, it needs to be fully opt-in.

[MatthewFlamm]

I'm more concerned about this part

this action is in maintenance-only mode and will not be accepting new features.

This means that any change that requires significant rework will probably be the end of it.

The action website states:

generally you want to use pre-commit.ciwhich is faster and has more features.

I think we decided to not go with that because we didn't want to have it modify the files independently.

I am fairly certain that you can turn off this behavior in pre-commit.ci. It has configuration options autofix_prs which would turn off auto-updates to PRs. Auto-updates to main branch opens a PR, it doesn't directly make changes, nor should it be possible since that branch is protected. See pull requests from https://github.com/python-telegram-bot/python-telegram-bot/pulls here which do not have any autoupdate changes in PRs, but have the pre-commit.ci checks run.

[akaszynski]

Thanks for the hint @MatthewFlamm!

Since pre-commit recommends for you to use their integration, I modified this PR to match python-telegram-bot/python-telegram-bot in:
https://github.com/python-telegram-bot/python-telegram-bot/blob/53093ebceb7375716840f16a794ebd028a6effbb/.pre-commit-config.yaml#L3-L5

I've disabled autofix_prs and made it 100% opt-in to match @banesullivan's request. Please note that you can run this manually on a PR by commenting with:

pre-commit.ci autofix

[MatthewFlamm]

I assume an administrator to this repo will have to install the app after merging.

[MatthewFlamm]

Oh wait it is working already 🥳

I assume we can get rid of this workflow too? https://github.com/pyvista/pyvista/blob/main/.github/workflows/pre-commit-update.yml

Or should we wait until it sends a PR first?

[tkoyama010]

@akaszynski Thanks for finding the configuration! I had been using pre-commit-bot as the default for my repositories, but I didn't realize it could be configured in such detail.

[tkoyama010]

I assume we can get rid of this workflow too?

@MatthewFlamm Good catch. Thanks!

[tkoyama010]

pre-commit.ci autofix

[akaszynski]

pre-commit.ci autofix

Yea, I'm going to use this a lot.

[tkoyama010]

OK! All my wishes have been granted and I thank the PyVista community for help. And welcome to our community pre-commit-ci[bot] !

[banesullivan]

Okay this is quite nice... thanks for making it opt-in with the comment, that's super useful