Demo to see how pre-commit and reviewdog respond to flake8 error #12
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* Update pre-commit hooks: - https://github.com/pre-commit/pre-commit-hooks: v4.0.1 → v4.2.0 - https://github.com/pycqa/flake8: v3.9.2 → v4.0.1 This is being applied manually and not waiting for pre-commit.ci to apply it as pre-commit.ci hasn't been turned on yet since these hooks were introduced in PR 21583.
Also remove comments in lib/matplotlib/backend_tools.py per request of maintainer in PR review.
Add a git blame ignore-revs file to automatically ignore commits listed in it from the blame view on GitHub. Include in it style changes added by pre-commit hooks which touch multiple files. To ignore the commits in the .git-blame-ignore-revs when running `git blame` locally run: `git blame --ignore-revs-file .git-blame-ignore-revs`. c.f.: * https://git-scm.com/docs/git-blame#Documentation/git-blame.txt---ignore-revs-fileltfilegt * https://docs.github.com/en/repositories/working-with-files/using-files/viewing-a-file#ignore-commits-in-the-blame-view
Add instructions to the devs on how to manually run pre-commit hooks, both for all the hooks, and for individual hook ids. Example: `pre-commit run flake8 --all-files` Also use the 'python -m pip' pattern to be consistent with the rest of the docs.
|
So to summarize:
There is of course the option of implementing both, but if pre-commit.ci is turned on then unless there is significant benefit gained from reviewdog's annotations it seems like adding reviewdog is just adding maintenance costs to the dev team. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What do pre-commit.ci and reviewdog do when a flake8 error is introduced?