SHELL实现svn必须添加注释后提交

最新推荐文章于 2023-11-28 19:13:04 发布

原创最新推荐文章于 2023-11-28 19:13:04 发布 · 201 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#shell

维护专栏收录该内容

30 篇文章

订阅专栏

本文介绍了如何通过脚本强制要求在提交代码到SVN仓库时添加注释，以提高代码可读性和追踪版本变化的能力。通过在预提交阶段检查注释内容，确保团队成员在修改代码时明确记录改动目的，从而提升团队协作效率。

最近在公司的项目中，因为很多人都参与开发，于是我们毫不犹豫的使用了svn来管理我们的项目，我们也特别强调，在提交代码的时候必须要添加注释，如果不添加注释，代码版本多了，根本搞不清，哪个版本改了什么东西？所以如果加一些注释的话，我们看起来，也方便很多。但是在真正的实际中，很多人都没有添加相关的注释，这里面的原因很多，因此决定通过脚本来控制这一过程，也就是实现必须要通过添加描述信息才能顺利的提交你的代码！。所以在提交的时候，我会强制要求写注释。如果对svn的安装配置不怎么了解，请参考：linux svn安装和配置，不结合apache

#cd /home/administrator/www/svntest svntest是一个代码仓库
#cp ./hooks/pre-commit.tmpl ./hooks/pre-commit 将代码仓库根目录下，hooks文件夹中的pre-commit.tmpl文件重命名为pre-commit
#chmod +x ./hooks/pre-commit
#vi ./hooks/pre-commit

修改前的SHELL脚本：

REPOS="$1"
TXN="$2"

# Make sure that the log message contains some text.
SVNLOOK=/usr/bin/svnlook
$SVNLOOK log -t "$TXN" "$REPOS" | \
 grep "[a-zA-Z0-9]" > /dev/null || exit 1

# Exit on all errors.
set -e

# Check that the author of this commit has the rights to perform
# the commit on the files and directories being modified.
"$REPOS"/hooks/commit-access-control.pl "$REPOS" $TXN \
 "$REPOS"/hooks/commit-access-control.cfg

# All checks passed, so allow the commit.
exit 0

修改后的脚本：

REPOS="$1"
TXN="$2"

# Make sure that the log message contains some text.
SVNLOOK=/usr/bin/svnlook

LOGMSG=`$SVNLOOK log -t $TXN $REPOS | wc -m`       //定义个变量，注意这里不是单引号

#$SVNLOOK log -t "$TXN" "$REPOS" | \               //把这一行和下面的一行注释掉
# grep "[a-zA-Z0-9]" > /dev/null || exit 1

echo $LOGMSG > /home/administrator/www/aaa.txt     //为了测试变量用的，查看$LOGMSG有没有值,最后要注释掉
if [ "$LOGMSG" -lt 48 ]                            //这里为什么是48呢，一个汉字对应16个字符
then
 echo "\n至少输入4个汉字" >&2                        //必须填四个汉字
 exit 1
fi

# Exit on all errors.
#set -e

# Check that the author of this commit has the rights to perform
# the commit on the files and directories being modified.
#"$REPOS"/hooks/commit-access-control.pl "$REPOS" $TXN \    //把这一行和下面的一行注释掉。
#  "$REPOS"/hooks/commit-access-control.cfg

# All checks passed, so allow the commit.
exit 0

保存退出后！执行提交操作，效果图如下：