关于SVN提交强制加入注释

 [[377595]]

本文转载自微信公众号「UP技术控」，作者conan5566  。转载本文请联系UP技术控公众号。 

背景

在开发项目过程中，团队中总是有人忘记添加注释。

解决思路

1、我们可以把这项工作交给电脑来完成岂不是更好。

2、提交代码的时候电脑自动提醒。

3、代码注释字数限制。以下为最少5个字为例子。

实现方法

方式一

1、用户提交代码的动作，对应的是pre-commit。因此，可以修改pre-commit.tmpl文件。 文件名修改为pre-commit, Windows下可以修改为pre-commit.bat。这样可以让系统知道该文件时可执行文件。

#!/bin/sh 
 
# PRE-COMMIT HOOK 
 
# 
 
# The pre-commit hook is invoked before a Subversion txn is 
 
# committed.  Subversion runs this hook by invoking a program 
 
# (script, executable, binary, etc.) named 'pre-commit' (for which 
 
# this file is a template), with the following ordered arguments: 
 
# 
 
#   [1] REPOS-PATH   (the path to this repository) 
 
#   [2] TXN-NAME     (the name of the txn about to be committed) 
 
# 
 
#   [STDIN] LOCK-TOKENS ** the lock tokens are passed via STDIN. 
 
# 
 
#   If STDIN contains the line "LOCK-TOKENS:\n" (the "\n" denotes a 
 
#   single newline), the lines following it are the lock tokens for 
 
#   this commit.  The end of the list is marked by a line containing 
 
#   only a newline character. 
 
# 
 
#   Each lock token line consists of a URI-escaped path, followed 
 
#   by the separator character '|', followed by the lock token string, 
 
#   followed by a newline. 
 
# 
 
# The default working directory for the invocation is undefined, so 
 
# the program should set one explicitly if it cares. 
 
# 
 
# If the hook program exits with success, the txn is committed; but 
 
# if it exits with failure (non-zero), the txn is aborted, no commit 
 
# takes place, and STDERR is returned to the client.   The hook 
 
# program can use the 'svnlook' utility to help it examine the txn. 
 
# 
 
# On a Unix system, the normal procedure is to have 'pre-commit' 
 
# invoke other programs to do the real work, though it may do the 
 
# work itself too. 
 
# 
 
#   ***  NOTE: THE HOOK PROGRAM MUST NOT MODIFY THE TXN, EXCEPT  *** 
 
#   ***  FOR REVISION PROPERTIES (like svn:log or svn:author).   *** 
 
# 
 
#   This is why we recommend using the read-only 'svnlook' utility. 
 
#   In the future, Subversion may enforce the rule that pre-commit 
 
#   hooks should not modify the versioned data in txns, or else come 
 
#   up with a mechanism to make it safe to do so (by informing the 
 
#   committing client of the changes).  However, right now neither 
 
#   mechanism is implemented, so hook writers just have to be careful. 
 
# 
 
# Note that 'pre-commit' must be executable by the user(s) who will 
 
# invoke it (typically the user httpd runs as), and that user must 
 
# have filesystem-level permission to access the repository. 
 
# 
 
# On a Windows system, you should name the hook program 
 
# 'pre-commit.bat' or 'pre-commit.exe', 
 
# but the basic idea is the same. 
 
# 
 
# The hook program typically does not inherit the environment of 
 
# its parent process.  For example, a common problem is for the 
 
# PATH environment variable to not be set to its usual value, so 
 
# that subprograms fail to launch unless invoked via absolute path. 
 
# If you're having unexpected problems with a hook program, the 
 
# culprit may be unusual (or missing) environment variables. 
 
# 
 
# Here is an example hook script, for a Unix /bin/sh interpreter. 
 
# For more examples and pre-written hooks, see those in 
 
# the Subversion repository at 
 
# http://svn.apache.org/repos/asf/subversion/trunk/tools/hook-scripts/ and 
 
# http://svn.apache.org/repos/asf/subversion/trunk/contrib/hook-scripts/ 
 
  
 
REPOS="$1" 
 
TXN="$2" 
 
# Make sure that the log message contains some text. 
 
SVNLOOK=/usr/local/bin/svnlook 
 
SVNLOOKlog−t"TXN" "$REPOS" | \ 
 
   grep "[a-zA-Z0-9]" > /dev/null || exit 1 
 
# Check that the author of this commit has the rights to perform 
 
# the commit on the files and directories being modified. 
 
commit-access-control.pl "REPOS""TXN" commit-access-control.cfg || exit 1 
 
# All checks passed, so allow the commit. 
 
exit 0 

把pre-commit文件的内容清楚复制下面的代码到pre-commit文件中： 
 
  
 
@echo off 
 
setlocal 
 
set REPOS=%1 
 
set TXN=%2 
 
rem check that logmessage contains at least 10 characters 
 
rem .....代表5个字符 
 
svnlook log "%REPOS%" -t "%TXN%" | findstr ".........." > nul 
 
if %errorlevel% gtr 0 goto err 
 
exit 0 
 
:err 
 
echo Empty log message not allowed. Commit aborted! 1>&2 
 
exit 1 

2、给pre-commit添加可执行权限： chmod +x pre-commit

方式二、直接在客服端设置

通过TortoiseSvn，在本地副本中，选择项目，右键选择TortoiseSvn，选择属性，添加tsvn:logminsize，将值限定为10，添加了logminsize属性后，要将本地工作副本commit一下，才能生效。如下图：

效果图