git - 使用预提交 Hook 在提交前修改文件

Question

我正在尝试编写一个预提交 Hook 来修改我代码中的一行，但我什至不知道从哪里开始。

问题是:

我有一个KEY

public static final String APP_KEY = ""; //DELETE THE KEY BEFORE COMMIT!!!

为了避免将 KEY 发布到存储库，我想也许 git hooks 是我们需要的东西，而不是手动删除 key 。我看过Customizing git hooks但是我不知道怎么写钩子(Hook)。

有没有办法在提交更改之前，删除 KEy 并在提交之后再次写入 key ？

Answer 1

这可以通过 content filter driver 来完成:

• 一个 clean 脚本，它会在检查时删除 key ，
• 一个 smudge 脚本，可以在 checkout 时将其添加回去。

^{(图片来自 Customizing Git Attributes 的“Git Book”)}

查看如何在“Can git automatically switch between spaces and tabs?”中声明这些过滤器的示例。

警告:

正如 Juan Alonso 在 the comments 中指出的:

I've had nothing but trouble with the clean/smudge scripts for a similar use-case, depending on the file contents unattended runs of git add -A would or wouldn't run the filter (as opposed to always working when calling git in attended mode).

So I ended up going with a pre-commit hook.