没有秘密的吉特
qpp-git-secrets的Python项目详细描述
Git机密
没有秘密的git
先决条件
Python 3是必需的。不支持Python2。
其次,python 3的bin
目录需要在PATH
环境变量中。例如,如果您使用
在macos上安装python.org,您需要将以下内容添加到您的~/.profile
。
PATH="/Library/Frameworks/Python.framework/Versions/3.*/bin:${PATH}"
安装
git-secrets
位于PyPI上。
要安装,请运行以下命令。
$ pip3 install qpp-git-secrets
sudo
如果python 3安装在受保护的目录中,则可能需要。这将把命令bin
python 3安装的目录。
要将git-secrets
更新到最新版本,请运行以下命令。
$ pip3 install --upgrade qpp-git-secrets
同样,可能需要sudo
。
用法
目前,git-secrets
只检查添加的暂存文件行。也就是说,只有将要添加的行
将检查已提交。
安装预提交挂钩
当pwd位于要添加预提交挂钩的存储库中时,运行以下命令…
$ git secrets install
如果存在一个^ {CD10>}目录,这将在该目录中添加一个BASH脚本。如果那个目录没有 存在,将直接创建^ {CD11}} BASH脚本。如果{{CD11}}脚本已经存在,^ {< CD4}} 将退出一个错误,因为它选择不删除以前的预提交脚本。
手动扫描
如果要手动扫描存储库,可以在pwd位于存储库中时运行以下命令…
$ git secrets scan
然后扫描秘密。
指定秘密
有两个位置git-secrets
检查机密规范。这两个地方的秘密是
合并在一起。
- 存储库顶层目录中的
.gitsecrets
文件。 ~/.gitsecrets
。
这些文件中的每一行都应该包含一个正则表达式。正则表达式语法基于
Python 3 ^{
示例机密
不以000
或999
开头或中间数组没有00
开头的罐头。
(\D|^)(?!000)(?!999)\d{3}\s(?!00)\d{2}\s\d{4}(\D|$) (\D|^)(?!000)(?!999)\d{3}-(?!00)\d{2}-\d{4}(\D|$) (\D|^)(?!000)(?!999)\d{3}(?!00)\d{2}\d{4}(\D|$)
开发
我接受减贫战略!查看issues。