關(guān)于SVN提交強制加入注釋
背景
?在開發(fā)項目過程中,團(tuán)隊中總是有人忘記添加注釋。
解決思路
? ?1、我們可以把這項工作交給電腦來完成豈不是更好。
??? 2、提交代碼的時候電腦自動提醒。
??? 3、代碼注釋字?jǐn)?shù)限制。以下為最少5個字為例子。
實現(xiàn)方法
方式一
1、用戶提交代碼的動作,對應(yīng)的是pre-commit。因此,可以修改pre-commit.tmpl文件。?文件名修改為pre-commit, Windows下可以修改為pre-commit.bat。這樣可以讓系統(tǒng)知道該文件時可執(zhí)行文件。
# 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/svnlookSVNLOOKlog?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文件的內(nèi)容清楚復(fù)制下面的代碼到pre-commit文件中:@echo offsetlocalset REPOS=%1set TXN=%2rem check that logmessage contains at least 10 charactersrem .....代表5個字符svnlook log "%REPOS%" -t "%TXN%" | findstr ".........." > nulif %errorlevel% gtr 0 goto errexit 0:errecho Empty log message not allowed. Commit aborted! 1>&2exit 1
2、給pre-commit添加可執(zhí)行權(quán)限:? chmod +x pre-commit

方式二、直接在客服端設(shè)置
?通過TortoiseSvn,在本地副本中,選擇項目,右鍵選擇TortoiseSvn,選擇屬性,添加tsvn:logminsize,將值限定為10,添加了logminsize屬性后,要將本地工作副本commit一下,才能生效。如下圖:



效果圖


評論
圖片
表情
