git - 如何使用这个 Git 预提交钩子(Hook)

Question

Yelp detect secrets是一个防止 secret 进入你的代码库的系统。我要安装the pre-commit hook它提供。

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

它们链接到 pre-commit.com ; “用于管理和维护多语言预提交 Hook 的框架”。

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

如果是这样，我有点迷失了预提交的使用。我已经安装了它，我可以调用它。所以在现有的 repo 中，我运行了 pre-commit install。但是我现在如何在提交前添加 yelp 检测 secret ？

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

Answer 1

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

detect-secrets 也提供了一个使用这个机制的钩子(Hook)，你可以使用 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)

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

(免责声明:我是 pre-commit 的作者)