git - 你如何注释一个分支？

Question

有什么方法可以注释分支吗？能够做这样的事情会很好:

$ git notes add branch-name -m 'This branch is for whatever'

但这当然不是很有帮助，因为该说明适用于当前分支机构的负责人，而不是分支机构本身。

一个简单的解决方法是在存储库中放置一个 README.branch-name，但这看起来很笨拙。稍微优雅一点的是拥有一个只包含 README.branch-names 的孤立分支。我正在寻找一种方法来记录分支的目的，而不仅仅是将其放入分支“第一次”提交的提交消息中。我把“第一”放在引号中，因为它的含义并不总是很清楚，这就是不方便将讨论放在提交消息中的原因。通常很难找到记录此类消息的提交。

Answer 1

这与 git note 完全不同。但你可以使用 git config对于此功能。

$ git config branch.<branch-name>.note 'This is what this branch is for'

这可以使用别名来简化界面(我猜这可以改进，但这是我使用的):

$ git config alias.branch-note '!git config branch.$(git symbolic-ref --short HEAD).note $( if [ $# -gt 0 ]; then $1; fi)'

这允许您像这样设置分支注释(确保引用注释):

$ git branch-note 'This is what this branch is for'

然后您可以像这样检索当前的分支注释:

$ git branch-note
This is what this branch is for

作为一个额外的好处，在 branch.<branch-name> 下定义的配置条目命名空间将跟随分支重命名，如果您稍后删除分支，它会自动清理。这些多余的配置条目只会在分支存在时持续存在，届时它们将被自动删除。

这种方法的缺点是每个分支只能存储一个“注释”。带有参数的后续分支注释调用将覆盖先前的分支注释。您也无法从将消息存储在可跟踪的 git 对象中获益，但也许它足以满足您的目的。