NEW Provide pre-commit hook #100
Conversation
# NEW Provide pre-commit hook This adds a pre-commit hook definition so that this repository can be easily used through pre-commit
|
#97 is the core pre-commit setup that uses third-party hooks to execute actions when you commit. #100 Proposes bash-unit as a hook that can be added to a pre-commit setup to run bash-unit upon the commit action (useable by other project). #97 could be updated to add the use of the bash-unit hook but then #100 needs to be available first in a way. You could accept #100 and #97 and if you want I'll add the use of this project's own hook to its pre-commit setup. |
| - id: bash-unit | ||
| ---- | ||
|
|
||
| == Running `+bash_unit+` in the test script |
There was a problem hiding this comment.
I would remove this section in the documentation as test_doc, in my opinion, is really advanced and odd use of bash_unit. One should not have to do that in 99.99% of the cases so that describing it here introduces some sort of noise in the doc, in my opinion and can even be a bit scary for new users :)
There was a problem hiding this comment.
FYI, I added bash_unit in these projects:
- https://github.com/mdeweerd/pre-commit-completion/blob/main/tests/test_pre_commit_completion.sh
- https://github.com/mdeweerd/pre-commit-php/blob/mdw/tests/test_doc.sh
But I may be the 0.00001% ;-).
README.adoc
Outdated
| @@ -78,6 +78,50 @@ You can also download it from the https://github.com/pgrange/bash_unit/releases[ | |||
|
|
|||
| endif::[] | |||
|
|
|||
| == pre-commit hook | |||
There was a problem hiding this comment.
I would add an extra = so that this becomes a sub-section of the installation section. Is it fair to say that running it with pre-commit hook is an alternative way of installing it?
NEW Provide pre-commit hook
This adds a pre-commit hook definition so that this repository can be easily used through pre-commit