svn添加强制注释，pre-commit结合python

Posted 2020-06-13

鉴于组内有些人在提交代码的时候并不写注释，而且没有固定格式，所以准备给svn提交时增加强制注释。

首先找到代码库里的hooks目录，正常建svn库的时候都有这个目录。进入hooks目录，找到pre-commit.tmpl，去掉tmpl，重命名为pre-commit。

这是一个shell脚本，如果是简单的判断注释内容不能小于几个字符，直接写shell脚本就可以，但是现在我想让开发按照固定格式提交代码，

例如：

    reason：电商

    developer：du

    reviewer：du

shell应该也是可以做到的，但是本人shell用的确实不怎么熟练，况且python写起来更简单，所以用了一种shell结合python的方式做hook。

首先上python脚本

check.py

#coding=utf-8
import sys  

inputstr = sys.argv[1]

if inputstr=="":
    exit(1);
lstr=inputstr.split("\n")
if len(lstr)==3:
    if (‘reason:‘ in lstr[0] and len(lstr[0])>len(‘reason:‘)) and (‘developer:‘ in lstr[1] and len(lstr[1])>len(‘developer:‘)) and (‘reviewer:‘ in lstr[2] and len(lstr[2])>len(‘reviewer:‘)):
       exit(0);
    else:
       exit(1);   
else:
    exit(1);

然后是pre-commit

 

#!/bin/sh
SVN_BINDIR=/opt/subversion/bin/svnlook
REPOS="$1"
TXN="$2"
LOGMSG=`$SVN_BINDIR log -t "$TXN" "$REPOS"`
var=`python /opt/svndata/repos/hooks/check.py "${LOGMSG}"`
result=$?
if [ $result -gt 0 ]
then
echo -e "you must input comment like this:\r\nreason:\r\ndeveloper:\r\nreviewer:" 1>&2
exit 1
fi
exit 0

这个pre-commit最好用vim来写，不要windows里写好再传到linux服务器上，会报格式错误，其实1>&2，-e也要加，只有这两个都加了，客户端提交的时候才能看到错误信息。
shell里对变量的引用 $result 和"$result"都可以，但是不要用单引号。还有if [ $result -gt 0 ]这块，空格一定要留出来，不然会报错。

验证一下，如下

无注释提交

会提示

上面的错误是系统原因，无大碍。主要是中间红框内的提示。我们可以看出增加强制注释成功。

----------------

由此例可以看出，我们完全可以在此基础上满足其他需求，例如提交代码发邮件，记日志入库等功能。