如何使用这个 Git 预提交挂钩

Question

Yelp detect secrets is a system that prevents secrets from entering your code base. I would like to install the pre-commit hook它提供。

我以前从未使用过Git hooks，但是我在.git/hooks/中看到的所有示例文件都在bash中，而在the readme中给出的示例yelp 是一个 yaml 文件。

他们link到pre-commit.com； “用于管理和维护多语言预提交挂钩的框架”。

这是否意味着 yelp 预提交挂钩只能通过首先安装 pre-commit 框架来使用？

如果是这样，我有点迷失了预提交的用法。我已经安装了它，我可以调用它。所以在现有的回购协议中，我运行 pre-commit install。但是我现在如何添加 yelp detect secrets pre commit 挂钩？

当然，我已经查看了 pre-commit.com 上的文档，但我有点迷路了。

Answer 1

要使用预提交，您需要设置一个 .pre-commit-config.yaml，其中包括您想使用的工具（例如空白修复程序、linters、black、flake8 等）

detect-secrets 还提供了一个使用此机制的钩子，您可以使用 the snippet they provide:

包含它

-   repo: https://github.com/Yelp/detect-secrets
    rev: v0.13.0
    hooks:
    -   id: detect-secrets
        args: ['--baseline', '.secrets.baseline']
        exclude: .*/tests/.*

（注意：我编辑了代码片段以使用更便携的 https 克隆 url）

还有更多标准工具可以处理此问题，例如 bandit（它也具有预提交集成）如果您发现检测秘密难以使用

（免责声明：我是预提交的作者）

如何使用这个 Git 预提交挂钩

How to use this Git pre-commit hook

git

pre-commit

pre-commit-hook

pre-commit.com