svn - VisualSVNサーバーでコミットメッセージを要求するには?

Question

VisualSVN サーバーを Windows 上の Subversion サーバーとしてセットアップし、ワークステーション上のクライアントとして Ankhsvn + TortoiseSVN を使用しています。

コミットメッセージが空でないことを要求するようにサーバーを構成するにはどうすればよいですか?

Answer 1

この質問をしてよかったです。これは、一般的な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

Answer 2

VisualSVN Server 3.9 は、VisualSVNServerHooks.exe check-logmessage空または短いログ メッセージでコミットを拒否するのに役立つ pre-commit フックを提供します。手順については、記事KB140: VisualSVN サーバーでのコミット ログ メッセージの検証を参照してください。

組み込みの に加えてVisualSVNServerHooks.exe、VisualSVN サーバーと SVN は一般に、このようなタスクを実行するために多くのフックを使用します。

• start-commit— コミット トランザクションが始まる前に実行され、特別な権限チェックを行うために使用できます
• pre-commit— トランザクションの最後に実行しますが、コミットの前に実行します。長さがゼロでないログメッセージなどを検証するためによく使用されます。
• post-commit— トランザクションがコミットされた後に実行されます。電子メールの送信、またはリポジトリのバックアップに使用できます。
• pre-revprop-change— リビジョン プロパティが変更される前に実行されます。権限の確認に使用できます。
• post-revprop-change— リビジョン プロパティの変更後に実行されます。これらの変更をメールまたはバックアップするために使用できます。

pre-commitフックを使用する必要があります。プラットフォームがサポートするほぼすべての言語で自分で作成できますが、Web 上には多数のスクリプトがあります。「コメントを要求するためのsvn precommitフック」をグーグルで検索すると、法案に適合するように見えるカップルが見つかりました。

• Perl スクリプト
• Python スクリプト

Answer 3

あなたの質問に対する技術的な回答はすでに与えられています。社会的な答えを追加したいと思います。それは、「チームとコミットメッセージの基準を確立し、表現力豊かなコミットメッセージが必要な理由に同意（または受け入れ）させることによって」です。

「パッチ」、「タイプミス」、「修正」などのコミット メッセージを非常に多く目にしたので、数えきれません。

本当に-なぜあなたがそれらを必要とするのかを誰にでも明確にしてください.

理由の例は次のとおりです。

• 生成された Changenotes (ええと、これは実際には、(私の名前で) 公に表示されることがわかっている場合、適切なメッセージを強制するための優れた自動ツールになります - チームのみの場合)
• ライセンスの問題: たとえば、コードのライセンスを変更したい場合など、後でコードの出所を知る必要がある場合があります (一部の組織では、コミット メッセージの書式設定の標準さえあります。これについては、チェックを自動化できますが、これで必ずしも良いコミットメッセージが得られるとは限りません)
• バージョン管理と連動し、コミット メッセージから情報を抽出するバグトラッカー/問題管理システムなど、他のツールとの相互運用性。

precommit フックに関する技術的な回答に加えて、それが役立つことを願っています。

Answer 4

以下は、 25 文字未満のログ メッセージのコミットを拒否する2 部構成のBatch + PowerShell pre-commit フックのサンプルです。

と の両方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 1252pre-commit.bat@echo off

Answer 5

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 の名前です。リポジトリの hooks ディレクトリにある pre-commit.tmpl も見てください。

Answer 6

開発に使用している言語でスクリプトを記述できるように、プリコミット フックに優れた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) {
  }
}

Answer 7

Windows でこの pre-commit フックを使用します。これは Windows Batch で記述されており、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 ツール バージョンをお勧めします。

Answer 8

フックを次のように指定して使用できる 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);

Answer 9

注: これは TortoiseSVN にのみ適用されます

リポジトリのトップ レベルを右クリックするだけです。コンテキスト メニューで TortoiseSVN を選択し、次に [プロパティ] を選択して、このダイアログを表示します。

右下にある [新規] ボタンをクリックし、[ログ サイズ] を選択します。コミットとロックに必要な文字数を入力します (以下の例では 10)。

変更した最上位ディレクトリからコミットします。これで、変更をコミットする前に、リポジトリですべてのユーザーがコメントする必要があります。

Answer 10

サーバーにコミット フックを追加する前に、svnprops を TortoiseSVN クライアントに配布しました。

したがって、代替手段として：

TortoiseSVN -> Properties プロパティ名 -tsvn:logminsize適切に追加/設定します。

もちろん、これはクライアント/ユーザーがそうしないことを選択できるため、サーバー上での保証ではありませんが、必要に応じて svnprops ファイルを配布できます。これにより、ユーザーは独自の値を設定する必要がなくなり、すべてのユーザーに値を提供できます。

これは bugtraq のようなものにも機能します: ログ内の問題追跡をリンクするための設定。