使用git项目中的简单配置文件轻松创建git挂钩
python-githooks的Python项目详细描述
python githhooks
Create git hooks with ease using a simple configuration file in a git project
安装
pip install python-githooks
用法
- 创建一个
.githooks.ini
配置文件(如果没有提供,将创建一个虚拟配置文件)。 - 根据
git hooks names
和command
属性添加要运行的shell代码的节。 - 在虚拟环境中运行
python -m python_githooks
或githooks
。
- 配置文件示例:
# .githooks.ini
[pre-commit]
command = pytest --cov
[pre-push]
command = pytest --cov && flake8
- 记住每次更改配置文件时都要重新运行
python -m python_githooks
或githooks
, 无论是添加新钩子还是修改当前钩子。
拆卸挂钩
如果您已经创建了一个钩子,现在要删除它,只需将命令值设置为空,如下所示:
# .githooks.ini
[pre-commit]
command =
这不会实际地从Git本地项目中移除钩子,只会使它立即退出^ {CD8>} 状态代码。
许可证
python githhooks是MIT-licensed。