当前位置:   article > 正文

Git commit 中的Change-Id是什么_git amend gerrit set change-id

git amend gerrit set change-id

什么是 Change-Id

Change-Id 其实就是一段形如 I7cbfa01f5136b8815e5e2c6dc5dcda28ce49d13a 的字符串,它的作用是:

保证已经提交审核的修订通过审核入库后,被别的分支 cherry-pick 后再推送至服务器时不会产生新的重复的评审任务。

Gerrit 设计了一套方法,即要求每个提交包含唯一的 Change-Id,这个 Change-Id 因为出现在日志中,当执行 cherry-pick 时也会保持,Gerrit 一旦发现新的提交包含了已经处理过的 Change-Id,就不再为该修订创建新的评审任务和 task-id,而直接将提交入库。
总之,Change-Id 就是 Gerrit 为了确保 cherry-pick 已提交审核的分支时不会在产生新的提交记录。

解决 ERROR:missing Change-Id in commit message

在一开始我们提到过,在执行 git push origin Head:refs/for/xxxx 时有时会报出上面标题这样的错误,也就是在 commit Message 仅仅包含如 feature:xxxx 等 title 这样的信息而缺少 Change-Id。那么怎样解决呢?

临时解决

git commit 有一个神奇的参数,叫做 --amend,如果我们遇到了上面的错误,可以执行下面的命令:

git commit --amend

然后我们可以看到最近一次 commit 的相关信息,在 title 下面空出一行(注意,一定要空出一行,否则 git 会把其作为 title 的一部分处理)后,将 Change-Id: XXXX 复制到 Message 中。然后就可以 push 了。你可能会问了,我哪知道 Change-Id 是什么呢?可以先查看一下之前的 commit 信息:

git log

然后你可能会看到这样一条信息:

现在你懂了吧,其实可以看到之前人提交 commit 信息的 Change-Id,我们只需要复制一下(注意 Change-Id: 后面有个空格)然后改一下其中某个字母就可以了(因为 Change-Id 不允许重复,如果重复了,可以再改一个字母,一般只需要改一个字母就可以了),这时我们就有了一个人工生成的 Change-Id 了。 注意,这种办法只是一种临时解决方案,下次如果你再想 commit 就需要再复制一个 Change-Id,然后 –amend 修改 commit 信息,是不是感觉每次这样修改很麻烦?没事,我们有一个永久解决方案:

自动生成 Change-Id

其实我们可以利用 commit-msg 这个 hook 文件自动生成 Change-Id,具体做法如下:

  • 将文章下面的 commit-msg hook 脚本复制到 git 项目中 .git/hooks 下,并命名为 commit-msg(一般情况下 .git/hooks 下会包含一个叫 commit-msg.sample 的文件,可以把它删除)
  • 添加完之后,执行
chmod u+x .git/hooks/commit-msg

激活 hook,以后提交的时候就会自动携带 Change-Id 了

  1. #!/bin/sh
  2. \# From Gerrit Code Review 2.6
  3. #
  4. \# Part of Gerrit Code Review (http://code.google.com/p/gerrit/)
  5. #
  6. \# Copyright (C) 2009 The Android Open Source Project
  7. #
  8. \# Licensed under the Apache License, Version 2.0 (the "License");
  9. \# you may not use this file except in compliance with the License.
  10. \# You may obtain a copy of the License at
  11. #
  12. \# http://www.apache.org/licenses/LICENSE-2.0
  13. #
  14. \# Unless required by applicable law or agreed to in writing, software
  15. \# distributed under the License is distributed on an "AS IS" BASIS,
  16. \# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17. \# See the License for the specific language governing permissions and
  18. \# limitations under the License.
  19. #
  20. unset GREP_OPTIONS
  21. CHANGE\_ID\_AFTER="Bug|Issue"
  22. MSG="$1"
  23. \# Check for, and add if missing, a unique Change-Id
  24. #
  25. add_ChangeId() {
  26. clean_message=`sed -e '
  27. /^diff --git a\\/.*/{
  28. s///
  29. q
  30. }
  31. /^Signed-off-by:/d
  32. /^#/d
  33. ' "$MSG" | git stripspace`
  34. if test -z "$clean_message"
  35. then
  36. return
  37. fi
  38. \# Does Change-Id: already exist? if so, exit (no change).
  39. if grep -i '^Change-Id:' "$MSG" >/dev/null
  40. then
  41. return
  42. fi
  43. id=`\_gen\_ChangeId`
  44. T="$MSG.tmp.$$"
  45. AWK=awk
  46. if \[ -x /usr/xpg4/bin/awk \]; then
  47. \# Solaris AWK is just too broken
  48. AWK=/usr/xpg4/bin/awk
  49. fi
  50. \# How this works:
  51. \# - parse the commit message as (textLine+ blankLine*)*
  52. \# - assume textLine+ to be a footer until proven otherwise
  53. \# - exception: the first block is not footer (as it is the title)
  54. \# - read textLine+ into a variable
  55. \# - then count blankLines
  56. \# - once the next textLine appears, print textLine+ blankLine* as these
  57. \# aren't footer
  58. \# - in END, the last textLine+ block is available for footer parsing
  59. $AWK '
  60. BEGIN {
  61. \# while we start with the assumption that textLine+
  62. \# is a footer, the first block is not.
  63. isFooter = 0
  64. footerComment = 0
  65. blankLines = 0
  66. }
  67. \# Skip lines starting with "#" without any spaces before it.
  68. /^#/ { next }
  69. \# Skip the line starting with the diff command and everything after it,
  70. \# up to the end of the file, assuming it is only patch data.
  71. \# If more than one line before the diff was empty, strip all but one.
  72. /^diff --git a/ {
  73. blankLines = 0
  74. while (getline) { }
  75. next
  76. }
  77. \# Count blank lines outside footer comments
  78. /^$/ && (footerComment == 0) {
  79. blankLines++
  80. next
  81. }
  82. \# Catch footer comment
  83. /^\\\[\[a-zA-Z0-9-\]+:/ && (isFooter == 1) {
  84. footerComment = 1
  85. }
  86. /\]$/ && (footerComment == 1) {
  87. footerComment = 2
  88. }
  89. \# We have a non-blank line after blank lines. Handle this.
  90. (blankLines > 0) {
  91. print lines
  92. for (i = 0; i < blankLines; i++) {
  93. print ""
  94. }
  95. lines = ""
  96. blankLines = 0
  97. isFooter = 1
  98. footerComment = 0
  99. }
  100. \# Detect that the current block is not the footer
  101. (footerComment == 0) && (!/^\\\[?\[a-zA-Z0-9-\]+:/ || /^\[a-zA-Z0-9-\]+:\\/\\//) {
  102. isFooter = 0
  103. }
  104. {
  105. \# We need this information about the current last comment line
  106. if (footerComment == 2) {
  107. footerComment = 0
  108. }
  109. if (lines != "") {
  110. lines = lines "\\n";
  111. }
  112. lines = lines $0
  113. }
  114. \# Footer handling:
  115. \# If the last block is considered a footer, splice in the Change-Id at the
  116. \# right place.
  117. \# Look for the right place to inject Change-Id by considering
  118. \# CHANGE\_ID\_AFTER. Keys listed in it (case insensitive) come first,
  119. \# then Change-Id, then everything else (eg. Signed-off-by:).
  120. #
  121. \# Otherwise just print the last block, a new line and the Change-Id as a
  122. \# block of its own.
  123. END {
  124. unprinted = 1
  125. if (isFooter == 0) {
  126. print lines "\\n"
  127. lines = ""
  128. }
  129. changeIdAfter = "^(" tolower("'"$CHANGE\_ID\_AFTER"'") "):"
  130. numlines = split(lines, footer, "\\n")
  131. for (line = 1; line <= numlines; line++) {
  132. if (unprinted && match(tolower(footer\[line\]), changeIdAfter) != 1) {
  133. unprinted = 0
  134. print "Change-Id: I'"$id"'"
  135. }
  136. print footer\[line\]
  137. }
  138. if (unprinted) {
  139. print "Change-Id: I'"$id"'"
  140. }
  141. }' "$MSG" > "$T" && mv "$T" "$MSG" || rm -f "$T"
  142. }
  143. \_gen\_ChangeIdInput() {
  144. echo "tree \`git write-tree\`"
  145. if parent=\`git rev-parse "HEAD^0" 2>/dev/null\`
  146. then
  147. echo "parent $parent"
  148. fi
  149. echo "author \`git var GIT\_AUTHOR\_IDENT\`"
  150. echo "committer \`git var GIT\_COMMITTER\_IDENT\`"
  151. echo
  152. printf '%s' "$clean_message"
  153. }
  154. \_gen\_ChangeId() {
  155. \_gen\_ChangeIdInput |
  156. git hash-object -t commit --stdin
  157. }
  158. add_ChangeId

来源:https://merrier.wang/20170820/what-is-change-id-in-git-commit.html

                              ‧‧‧‧‧‧‧‧‧‧‧‧‧‧‧‧  END  ‧‧‧‧‧‧‧‧‧‧‧‧‧‧‧‧

推荐阅读

【1】jetson nano开发使用的基础详细分享

【2】Linux开发coredump文件分析实战分享

【3】CPU中的程序是怎么运行起来的 必读

【4】cartographer环境建立以及建图测试

【5】设计模式之简单工厂模式、工厂模式、抽象工厂模式的对比

本公众号全部原创干货已整理成一个目录,回复[ 资源 ]即可获得。

声明:本文内容由网友自发贡献,不代表【wpsshop博客】立场,版权归原作者所有,本站不承担相应法律责任。如您发现有侵权的内容,请联系我们。转载请注明出处:https://www.wpsshop.cn/w/我家自动化/article/detail/68206
推荐阅读
相关标签
  

闽ICP备14008679号