Improve pre-commit framework docs #58
Merged
Conversation
This file contains 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
adamchainz
commented
Feb 1, 2023
Comment on lines
-101
to
+91
| - repo: https://github.com/sirwart/ripsecrets.git | ||
| # Set your version, be sure to use the latest and update regularly or use 'main' | ||
| rev: v0.1.5 | ||
| - repo: https://github.com/sirwart/ripsecrets |
There was a problem hiding this comment.
FYI the .git is not needed on the end for cloning repos, as explained by pre-commit creator Anthony in this video - removing it to match the pre-commit style
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.
Hi @sirwart , thanks for the great tool. I'm just writing up a book section on how to set up ripsecrets, via pre-commit, and I thought I'd try improve the instructions in the repo whilst I'm at it.
I made these improvements:
pre-commit autoupdatecommand, or use pre-commit.ci that runs this for you.ripsecretshook, because since version 2.21.0, pre-commit can bootstrap Rust if it is unavailable (pre-commit PR, open docs improvement PR). This should make theripsecretshook preferable toripsecrets-system.