Trivial demo tasks for git users.
Project description
# flowtool-githooks-demo
This package contains some example git hooks.
The hooks are made runnable via console_scripts entry points. The hooks are also recognized by the flowtool-githooks management via entry points. That just means for a user of this tool, that the hooks will show up in the ft githooks-scripts menu automatically, and can also be run via their name from the command line.
## Setting things up
To install the hook runner and set up the demo hook try these commands: `shell $ flowtool githooks-install $ flowtool githooks-scripts --hook pre-commit --add _flowtool_githooks.demo $ flowtool githooks-scripts --hook commit-msg --add _flowtool_githooks.demo $ flowtool githooks-scripts --hook pre-push --add _flowtool_githooks.demo `
To configure the hooks interactively:
`shell $ flowtool githooks-scripts --help $ flowtool githooks-scripts `
To unistall the hooks use:
`shell $ flowtool githooks-scripts --hook pre-commit --remove _flowtool_githooks.demo $ flowtool githooks-wipe `
## _flowtool_githooks.demo
A git hook to showcase the possibilities of git hooks. It prints its (command line) arguments and various information that may or may not be interesting to someone developing a hook for his own purposes.
As one main feature, it reads it’s standard input non-blocking and outputs it if there is anything, since only some hooks get additional information passed in via stdin.
## _flowtool_githooks.demo_fail
A git hook that will always fail.
Good to test what a non-zero exit status will do for certain hooks.
## _flowtool_githooks.shellcheck
A step towards a collection of git hooks, that wrap code checkers. This one wraps [shellcheck](https://github.com/koalaman/shellcheck), a shell script syntax, style and security checker.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Hashes for flowtool-githooks-demo-0.7.13.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 19641dd2b87c1ff51de95bc008d8b093b987c8199ad6c17d0dcb3deb527ee41b |
|
MD5 | fd0815dc9094a6cdf265e38ef05773a6 |
|
BLAKE2b-256 | 5832c2ee682305c2f6e0772c40a19e2d957b828b752f24061de802fa63faefce |