關於SVN提交強制加入注釋

一、摘要

 

場景：

    在這次開發項目過程中，團隊中總是有人忘記添加注釋。

問題：

    1：其他成員不知道你提交是什么代碼, 給回滾操作帶來很多不必要的麻煩。

    2：這個工作需要有一個人天天提醒大家在提交代碼的時候加入注釋。

    3：這個是重復的，定時的，固定的 工作。

思路：

    1：我們可以把這項工作交給電腦來完成豈不是更好。

    2：提交代碼的時候電腦自動提醒。

    3：代碼注釋字數限制。以下為最少5個字為例子。

 

二、本文大綱

       a、摘要。

       b、本文大綱。

       c、第一步創建SVN版本庫。

       d、第二步 pre-commit.tmpl 修改前代碼：。

       e、第三步 pre-commit.bat 修改后代碼：（Windows）。

       f、第二個方法，直接在客服端設置。

       j、第四步 效果圖。

三、第一步創建SVN版本庫

在 SVNDataBase文件夾上建立版本庫SVNDataBase文件夾必須是空的這個SVN會提示的。

在hooks文件夾下找到

用戶提交代碼的動作，對應的是pre-commit。因此，可以修改pre-commit.tmpl文件。
文 件名修改為pre-commit, Windows下可以修改為pre-commit.bat。這樣可以讓系統知道該文件時可執行文件。

四、第二步 pre-commit.tmpl 修改前代碼

 

#!/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

$SVNLOOK log -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.bat 修改后代碼 ( Windows )

把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

 

如下：

給pre-commit添加可執行權限： 
chmod +x pre-commit

 

六、第二個方法，直接在客服端設置

 

   通過TortoiseSvn，在本地副本中，選擇項目，右鍵選擇TortoiseSvn，選擇屬性，添加tsvn:logminsize，將值限定為10，添加了logminsize屬性后，要將本地工作副本commit一下，才能生效。如下圖：

 

七、第五步 效果圖

 

小於5個字符 提示如下：

 

修改注釋目前在工作上還沒有遇到，嘿嘿。就先不研究啦。