VisualSVNサーバーでコミットメッセージを要求する方法
VisualSVNサーバーをWindowsのSubversionサーバーとして設定し、ワークステーションのクライアントとしてAnkhsvn + TortoiseSVNを使用します。
コミットメッセージが空でないことを要求するようにサーバーを構成するにはどうすればよいですか？
VisualSVNサーバー3.9は、空または短いログメッセージでコミットを拒否するのに役立つVisualSVNServerHooks.exe check-logmessage事前コミットフックを提供します。手順については、記事 KB140：Validate commit log messages in VisualSVN Server を参照してください。
組み込みのVisualSVNServerHooks.exeに加えて、VisualSVNサーバーとSVNは一般に フックの数 を使用してこのようなタスクを実行します。
start-commit—トランザクションのコミットが開始する前に実行され、特別な権限チェックを行うために使用できますpre-commit—トランザクションの最後、ただしコミット前に実行します。長さがゼロでないログメッセージなどの検証によく使用されます。post-commit—トランザクションがコミットされた後に実行されます。メールの送信やリポジトリのバックアップに使用できます。pre-revprop-change—リビジョンプロパティが変更される前に実行されます。権限の確認に使用できます。post-revprop-change—リビジョンプロパティの変更後に実行されます。これらの変更をメールまたはバックアップするために使用できます。
pre-commitフックを使用する必要があります。プラットフォームでサポートされているほぼすべての言語で自分で作成できますが、Web上には多数のスクリプトがあります。グーグル "コメントを要求するsvn precommitフック"私は彼らが法案に合うように見えるカップルを見つけました：
この質問をしていただき、ありがとうございます。これは、一般的な Windows Batch で記述されたコミット前のフックスクリプトです。ログメッセージが6文字未満の場合、コミットを拒否します。 pre-commit.batをフックディレクトリに置くだけです。
pre-commit.bat
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
あなたの質問に対する技術的な答えはすでに与えられています。ソーシャルアンサーを追加したいと思います。「コミットメッセージの標準をチームと確立し、表現力のあるコミットが必要な理由に同意（または受け入れ）させる」メッセージ」
"patch"、 "typo"、 "fix"などの多くのコミットメッセージが表示されて、数が減っています。
本当に-なぜあなたがそれらを必要とするのかを皆に明確にしてください。
理由の例は次のとおりです。
- 生成されたChangenotes（まあ-これは実際に、（私の名前で）パブリックに表示されることがわかっている場合、適切なメッセージを強制するニース自動ツールを作成します-チームのみの場合）
- ライセンスの問題：後でコードの出所を知る必要があるかもしれません。ライセンスをコードに変更する必要がある場合（一部の組織では、コミットメッセージのフォーマットに関する標準さえあります。まあ、これのチェックを自動化することはできますが、必ずしもgoodこれでメッセージをコミット）
- 他のツールとの相互運用性、たとえばバージョン管理とインターフェイスし、コミットメッセージから情報を抽出するバグトラッカー/問題管理システム。
プリコミットフックに関する技術的な回答に加えて、それが役立つことを願っています。
以下は、2つの部分のサンプルBatch + PowerShellコミット前フックで、25文字未満のログメッセージのコミットを拒否します。
pre-commit.batとpre-commit.ps1の両方をリポジトリに入れてくださいhooksフォルダ。 C:\Repositories\repository\hooks\
pre-commit.ps1
# Store hook arguments into variables with mnemonic names
$repos = $args[0]
$txn = $args[1]
# Build path to svnlook.exe
$svnlook = "$env:VISUALSVN_SERVER\bin\svnlook.exe"
# Get the commit log message
$log = (&"$svnlook" log -t $txn $repos)
# Check the log message contains non-empty string
$datalines = ($log | where {$_.trim() -ne ""})
if ($datalines.length -lt 25)
{
# Log message is empty. Show the error.
[Console]::Error.WriteLine("Commit with empty log message is prohibited.")
exit 3
}
exit 0
pre-commit.bat
@echo off
set PWSH=%SystemRoot%\System32\WindowsPowerShell\v1.0\powershell.exe
%PWSH% -command $input ^| %1\hooks\pre-commit.ps1 %1 %2
if errorlevel 1 exit %errorlevel%
注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を検索）（テストされていません）。
SVNLOOK.exe log -t "%2" "%1" | grep.exe "[a-zA-Z0-9]" > nul || GOTO ERROR
GOTO OK
:ERROR
ECHO "Please enter comment and then retry commit!"
exit 1
:OK
exit 0
パスにgrep.exeが必要です。％1はこのリポジトリへのパス、％2はコミットされるtxnの名前です。また、リポジトリのフックディレクトリにあるpre-commit.tmplも確認してください。
コミット前のフックに優れた CS-Script ツールを使用して、開発中の言語でスクリプトを記述できるようにします。ここでは、10文字を超えるコミットメッセージがあることを確認する例を示します。 、および.suoファイルと.userファイルがチェックインされないようにします。タブ/スペースのインデントをテストしたり、チェックイン時に小さなコード標準を適用したりすることもできますが、スクリプトの実行が多すぎることに注意してください。コミットを遅くしたい。
// 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) {
}
}
以下は、フックを次のように指定して使用できるWindowsシェルJScriptです。
%SystemRoot%\System32\CScript.exe //nologo <..path..to..script> %1 %2
とても読みやすいので、実験を行ってください。
ところで、JScriptでこれを行う理由は、インストールする他のツール（Perl、CygWinなど）に依存しないためです。
if (WScript.Arguments.Length < 2)
{
WScript.StdErr.WriteLine("Repository Hook Error: Missing parameters. Should be REPOS_PATH then TXN_NAME, e.g. %1 %2 in pre-commit hook");
WScript.Quit(-1);
}
var oShell = new ActiveXObject("WScript.Shell");
var oFSO = new ActiveXObject("Scripting.FileSystemObject");
var preCommitStdOut = oShell.ExpandEnvironmentStrings("%TEMP%\\PRE-COMMIT." + WScript.Arguments(1) + ".stdout");
var preCommitStdErr = oShell.ExpandEnvironmentStrings("%TEMP%\\PRE-COMMIT." + WScript.Arguments(1) + ".stderr");
var commandLine = "%COMSPEC% /C \"C:\\Program Files\\VisualSVN Server\\bin\\SVNLook.exe\" log -t ";
commandLine += WScript.Arguments(1);
commandLine += " ";
commandLine += WScript.Arguments(0);
commandLine += "> " + preCommitStdOut + " 2> " + preCommitStdErr;
// Run Synchronously, don't show a window
// WScript.Echo("About to run: " + commandLine);
var exitCode = oShell.Run(commandLine, 0, true);
var fsOUT = oFSO.GetFile(preCommitStdOut).OpenAsTextStream(1);
var fsERR = oFSO.GetFile(preCommitStdErr).OpenAsTextStream(1);
var stdout = fsOUT && !fsOUT.AtEndOfStream ? fsOUT.ReadAll() : "";
var stderr = fsERR && !fsERR.AtEndOfStream ? fsERR.ReadAll() : "";
if (stderr.length > 0)
{
WScript.StdErr.WriteLine("Error with SVNLook: " + stderr);
WScript.Quit(-2);
}
// To catch naught commiters who write 'blah' as their commit message
if (stdout.length < 5)
{
WScript.StdErr.WriteLine("Please provide a commit message that describes why you've made these changes.");
WScript.Quit(-3);
}
WScript.Quit(0);
Windowsでこのpre-commitフックを使用します。これはWindowsバッチで記述されており、 grep コマンドラインユーティリティを使用してコミットの長さをチェックします。
svnlook log -t "%2" "%1" | c:\tools\grep -c "[a-zA-z0-9]" > nul
if %ERRORLEVEL% NEQ 1 exit 0
echo Please enter a check-in comment 1>&2
exit 1
Grepのコピーが必要になることを忘れないでください gnu tools version をお勧めします。
注：これはTortoiseSVNにのみ適用されます
リポジトリの最上位を右クリックするだけです。コンテキストメニューでTortoiseSVNを選択し、次に[プロパティ]を選択して、このダイアログを表示します。
右下の[新規]ボタンをクリックし、[ログサイズ]を選択します。コミットとロックに必要な文字数を入力します（下の例では10）。
変更したばかりの最上位ディレクトリからコミットを実行します。これで、リポジトリは変更をコミットする前にすべてのユーザーにコメントを要求します。
サーバーにコミットフックを追加する前に、svnpropsをTortoiseSVNクライアントに配布しました。
したがって、代替策として：
TortoiseSVN->プロパティプロパティ名-追加/設定tsvn:logminsize適切に。
もちろん、これはサーバーでは保証されていません。クライアント/ユーザーはそれをしないことを選択できますが、必要に応じてsvnpropsファイルを配布できます。このように、ユーザーは独自の値を設定する必要はありません-すべてのユーザーにそれらを提供できます。
これは、バグ追跡のようなものでも機能します：ログ内の問題追跡関連をリンクする設定。
メッセージをチェックするpre-commitフックを設定する必要があると思います。
実際、最初に得た結果をグーグルするだけで、意図したとおりに実行するPerlのプリコミットスクリプトができました。