setlocal enabledelayedexpansion
set REPOS=%1
set TXN=%2
set SVNLOOK="%VISUALSVN_SERVER%\bin\svnlook.exe"
SET M=
REM Concatenate all the lines in the commit message
FOR /F "usebackq delims==" %%g IN (`%SVNLOOK% log -t %TXN% %REPOS%`) DO SET M=!M!%%g
REM Make sure M is defined
SET M=0%M%
REM Here the 6 is the length we require
IF NOT "%M:~6,1%"=="" goto NORMAL_EXIT
:ERROR_TOO_SHORT
echo "Commit note must be at least 6 letters" >&2
goto ERROR_EXIT
:ERROR_EXIT
exit /b 1
REM All checks passed, so allow the commit.
:NORMAL_EXIT
exit 0
我们使用优秀的CS-Script工具进行预提交钩子，这样我们就可以用我们的语言编写脚本，确保有's a commit message longer than 10 characters, and ensures that .suo and .user files aren'签入 . 您还可以测试制表符/空格缩进，或执行小代码标准执行在办理登机手续时，但要小心使你的脚本做得太多，因为你不想减慢提交速度 .
// run from pre-commit.cmd like so:
// css.exe /nl /c C:\SVN\Scripts\PreCommit.cs %1 %2
using System;
using System.Diagnostics;
using System.Text;
using System.Text.RegularExpressions;
using System.Linq;
class PreCommitCS {
/// <summary>Controls the procedure flow of this script</summary>
public static int Main(string[] args) {
if (args.Length < 2) {
Console.WriteLine("usage: PreCommit.cs repository-path svn-transaction");
Environment.Exit(2);
}
try {
var proc = new PreCommitCS(args[0], args[1]);
proc.RunChecks();
if (proc.MessageBuffer.ToString().Length > 0) {
throw new CommitException(String.Format("Pre-commit hook violation\r\n{0}", proc.MessageBuffer.ToString()));
}
}
catch (CommitException ex) {
Console.WriteLine(ex.Message);
Console.Error.WriteLine(ex.Message);
throw ex;
}
catch (Exception ex) {
var message = String.Format("SCRIPT ERROR! : {1}{0}{2}", "\r\n", ex.Message, ex.StackTrace.ToString());
Console.WriteLine(message);
Console.Error.WriteLine(message);
throw ex;
}
// return success if we didn't throw
return 0;
}
public string RepoPath { get; set; }
public string SvnTx { get; set; }
public StringBuilder MessageBuffer { get; set; }
/// <summary>Constructor</summary>
public PreCommitCS(string repoPath, string svnTx) {
this.RepoPath = repoPath;
this.SvnTx = svnTx;
this.MessageBuffer = new StringBuilder();
}
/// <summary>Main logic controller</summary>
public void RunChecks() {
CheckCommitMessageLength(10);
// Uncomment for indent checks
/*
string[] changedFiles = GetCommitFiles(
new string[] { "A", "U" },
new string[] { "*.cs", "*.vb", "*.xml", "*.config", "*.vbhtml", "*.cshtml", "*.as?x" },
new string[] { "*.designer.*", "*.generated.*" }
);
EnsureTabIndents(changedFiles);
*/
CheckForIllegalFileCommits(new string[] {"*.suo", "*.user"});
}
private void CheckForIllegalFileCommits(string[] filesToExclude) {
string[] illegalFiles = GetCommitFiles(
new string[] { "A", "U" },
filesToExclude,
new string[] {}
);
if (illegalFiles.Length > 0) {
Echo(String.Format("You cannot commit the following files: {0}", String.Join(",", illegalFiles)));
}
}
private void EnsureTabIndents(string[] filesToCheck) {
foreach (string fileName in filesToCheck) {
string contents = GetFileContents(fileName);
string[] lines = contents.Replace("\r\n", "\n").Replace("\r", "\n").Split(new string[] { "\n" }, StringSplitOptions.None);
var linesWithSpaceIndents =
Enumerable.Range(0, lines.Length)
.Where(i => lines[i].StartsWith(" "))
.Select(i => i + 1)
.Take(11)
.ToList();
if (linesWithSpaceIndents.Count > 0) {
var message = String.Format("{0} has spaces for indents on line(s): {1}", fileName, String.Join(",", linesWithSpaceIndents));
if (linesWithSpaceIndents.Count > 10) message += "...";
Echo(message);
}
}
}
private string GetFileContents(string fileName) {
string args = GetSvnLookCommandArgs("cat") + " \"" + fileName + "\"";
string svnlookResults = ExecCmd("svnlook", args);
return svnlookResults;
}
private void CheckCommitMessageLength(int minLength) {
string args = GetSvnLookCommandArgs("log");
string svnlookResults = ExecCmd("svnlook", args);
svnlookResults = (svnlookResults ?? "").Trim();
if (svnlookResults.Length < minLength) {
if (svnlookResults.Length > 0) {
Echo("Your commit message was too short.");
}
Echo("Please describe the changes you've made in a commit message in order to successfully commit. Include support ticket number if relevant.");
}
}
private string[] GetCommitFiles(string[] changedIds, string[] includedFiles, string[] exclusions) {
string args = GetSvnLookCommandArgs("changed");
string svnlookResults = ExecCmd("svnlook", args);
string[] lines = svnlookResults.Split(new string[] { "\r", "\n" }, StringSplitOptions.RemoveEmptyEntries);
var includedPatterns = (from a in includedFiles select ConvertWildcardPatternToRegex(a)).ToArray();
var excludedPatterns = (from a in exclusions select ConvertWildcardPatternToRegex(a)).ToArray();
var opts = RegexOptions.IgnoreCase;
var results =
from line in lines
let fileName = line.Substring(1).Trim()
let changeId = line.Substring(0, 1).ToUpper()
where changedIds.Any(x => x.ToUpper() == changeId)
&& includedPatterns.Any(x => Regex.IsMatch(fileName, x, opts))
&& !excludedPatterns.Any(x => Regex.IsMatch(fileName, x, opts))
select fileName;
return results.ToArray();
}
private string GetSvnLookCommandArgs(string cmdType) {
string args = String.Format("{0} -t {1} \"{2}\"", cmdType, this.SvnTx, this.RepoPath);
return args;
}
/// <summary>
/// Executes a command line call and returns the output from stdout.
/// Raises an error is stderr has any output.
/// </summary>
private string ExecCmd(string command, string args) {
Process proc = new Process();
proc.StartInfo.FileName = command;
proc.StartInfo.Arguments = args;
proc.StartInfo.UseShellExecute = false;
proc.StartInfo.CreateNoWindow = true;
proc.StartInfo.RedirectStandardOutput = true;
proc.StartInfo.RedirectStandardError = true;
proc.Start();
var stdOut = proc.StandardOutput.ReadToEnd();
var stdErr = proc.StandardError.ReadToEnd();
proc.WaitForExit(); // Do after ReadToEnd() call per: http://chrfalch.blogspot.com/2008/08/processwaitforexit-never-completes.html
if (!string.IsNullOrWhiteSpace(stdErr)) {
throw new Exception(string.Format("Error: {0}", stdErr));
}
return stdOut;
}
/// <summary>
/// Writes the string provided to the Message Buffer - this fails
/// the commit and this message is presented to the comitter.
/// </summary>
private void Echo(object s) {
this.MessageBuffer.AppendLine((s == null ? "" : s.ToString()));
}
/// <summary>
/// Takes a wildcard pattern (like *.bat) and converts it to the equivalent RegEx pattern
/// </summary>
/// <param name="wildcardPattern">The wildcard pattern to convert. Syntax similar to VB's Like operator with the addition of pipe ("|") delimited patterns.</param>
/// <returns>A regex pattern that is equivalent to the wildcard pattern supplied</returns>
private string ConvertWildcardPatternToRegex(string wildcardPattern) {
if (string.IsNullOrEmpty(wildcardPattern)) return "";
// Split on pipe
string[] patternParts = wildcardPattern.Split('|');
// Turn into regex pattern that will match the whole string with ^$
StringBuilder patternBuilder = new StringBuilder();
bool firstPass = true;
patternBuilder.Append("^");
foreach (string part in patternParts) {
string rePattern = Regex.Escape(part);
// add support for ?, #, *, [...], and [!...]
rePattern = rePattern.Replace("\\[!", "[^");
rePattern = rePattern.Replace("\\[", "[");
rePattern = rePattern.Replace("\\]", "]");
rePattern = rePattern.Replace("\\?", ".");
rePattern = rePattern.Replace("\\*", ".*");
rePattern = rePattern.Replace("\\#", "\\d");
if (firstPass) {
firstPass = false;
}
else {
patternBuilder.Append("|");
}
patternBuilder.Append("(");
patternBuilder.Append(rePattern);
patternBuilder.Append(")");
}
patternBuilder.Append("$");
string result = patternBuilder.ToString();
if (!IsValidRegexPattern(result)) {
throw new ArgumentException(string.Format("Invalid pattern: {0}", wildcardPattern));
}
return result;
}
private bool IsValidRegexPattern(string pattern) {
bool result = true;
try {
new Regex(pattern);
}
catch {
result = false;
}
return result;
}
}
public class CommitException : Exception {
public CommitException(string message) : base(message) {
}
}
11 回答
VisualSVN Server 3.9提供了
VisualSVNServerHooks.exe check-logmessage预提交挂钩，可帮助您拒绝空或短日志消息的提交 . 有关说明，请参阅文章KB140: Validating commit log messages in VisualSVN Server .除了内置的
VisualSVNServerHooks.exe，VisualSVN Server和SVN通常使用number of hooks来完成这样的任务 .start-commit - 在提交事务开始之前运行，可用于执行特殊权限检查
pre-commit - 在事务结束时运行，但在提交之前运行 . 通常用于验证诸如非零长度日志消息之类的内容 .
post-commit - 在提交事务后运行 . 可用于发送电子邮件或备份存储库 .
pre-revprop-change - 在修订版属性更改之前运行 . 可用于检查权限 .
post-revprop-change - 在修订版属性更改后运行 . 可用于通过电子邮件发送或备份这些更改 .
你需要使用
pre-commit钩子 . 您可以使用您的平台支持的任何语言自己编写，但Web上有许多脚本 . 谷歌搜索"svn precommit hook to require comment"我找到了一对看起来像是符合条件的夫妇：Perl Script
Python Script
我很高兴你问这个问题 . 这是我们共同编写的预提交钩子脚本Windows Batch . 如果日志消息少于6个字符，则拒绝提交 . 只需将pre-commit.bat放入hooks目录即可 .
pre-commit.bat
已经给出了您的问题的技术答案 . 我想添加社交答案，即：“通过与您的团队 Build 提交消息标准并让他们同意（或接受）为什么需要表达性提交消息的原因”
我看过很多提交消息，上面写着“补丁”，“拼写错误”，“修复”或类似错误 .
真的 - 让每个人都清楚你为什么需要它们 .
原因的例子是：
Generated Changenotes （好吧 - 这实际上是一个很好的自动工具来强制执行好消息，如果我知道他们将（以我的名字）公开可见 - 如果只是为了团队）
License issues ：您可能需要稍后知道代码的来源，例如你是否想要将许可证更改为你的代码（有些组织甚至有提交消息格式的标准 - 好吧，你可以自动检查这个，但你不一定得到好的提交消息）
Interoperability with other tools ，例如bugtrackers / issue管理系统，它与您的版本控制接口并从提交消息中提取信息 .
希望有帮助，除了关于precommit钩子的技术答案 .
这是一个两部分示例 Batch + PowerShell pre-commit hook，它拒绝提交少于25个字符的日志消息 .
将 pre-commit.bat 和 pre-commit.ps1 放入您的存储库 hooks 文件夹，例如
C:\Repositories\repository\hooks\pre-commit.ps1
pre-commit.bat
注1：
pre-commit.bat是VisualSVN可以调用的唯一一个pre-commit.ps1是pre-commit.bat调用的那个 .注2：
pre-commit.bat也可以命名为pre-commit.cmd.注3：如果您尝试使用某些重音字符和
[Console]::Error.WriteLine输出进行编码问题，则将chcp 1252添加到pre-commit.bat，@echo off之后的下一行 .VisualSVN为您提供的钩子是“Windows NT命令脚本”，它们基本上是批处理文件 .
在批处理文件中编写if-then-else非常难看，可能很难调试 .
它将类似于以下内容（搜索pre-commit.bat）（未测试）：
您需要路径上的grep.exe，％1是此存储库的路径，％2是要提交的txn的名称 . 还要查看存储库的hooks目录中的pre-commit.tmpl .
我们使用优秀的CS-Script工具进行预提交钩子，这样我们就可以用我们的语言编写脚本，确保有's a commit message longer than 10 characters, and ensures that .suo and .user files aren'签入 . 您还可以测试制表符/空格缩进，或执行小代码标准执行在办理登机手续时，但要小心使你的脚本做得太多，因为你不想减慢提交速度 .
这是一个Windows Shell JScript，您可以通过将钩子指定为：
这很美易于阅读，所以继续进行实验 .
顺便说一句，在JScript中这样做的原因是它不依赖于任何其他工具（Perl，CygWin等）来安装 .
在Windows上使用此预提交挂钩 . 它是用Windows Batch编写的，并使用grep命令行实用程序来检查提交长度 .
请记住，你需要一份grep副本，我推荐gnu tools version .
Note: This Only Applies To TortoiseSVN
只需右键单击存储库的顶级 . 在上下文菜单中选择TortoiseSVN，然后选择Properties，以查看此对话框：
单击右下角附近的“新建”按钮，然后选择“日志大小” . 输入提交和锁定所需的字符数（下例中为10） .
从刚修改的顶级目录执行提交 . 现在，您的存储库要求所有用户在提交更改之前进行注释 .
在将提交挂钩添加到我的服务器之前，我只是将svnprops分发给TortoiseSVN客户端 .
所以，作为替代方案：
在TortoiseSVN - >属性属性名称 - 适当添加/设置
tsvn:logminsize.这当然不能保证在服务器上，因为客户端/用户可以选择不这样做，但是如果你愿意，你可以分发svnprops文件 . 这样，用户就不必设置自己的值 - 您可以将它们提供给所有用户 .
这也适用于bugtraq：设置以链接日志中的问题跟踪内容 .
我相信你必须设置一个预提交钩子来检查消息 .
事实上，通过谷歌搜索我得到的第一个结果是一个perl预提交脚本，完全按照你的意图 .
Perl pre-commit hook example (untested)