SVN预提交钩子,用于避免更改标签子目录

时间:2009-01-21 07:59:06

标签: svn tags svn-hooks pre-commit

是否有人明确指示如何添加预提交挂钩以避免更改标记子目录?

我已经在互联网上搜索了一下。我找到了这个链接:SVN::Hooks::DenyChanges,但我似乎无法编译。

11 个答案:

答案 0 :(得分:39)

我没有足够的声誉对Raim上面的答案进行“评论”,但是他的表现很好,除了一个例外,他的grep模式是错误的。

我只是使用下面作为我的预提交钩子(我没有现有的钩子,你需要在这种情况下合并):

#!/bin/sh

REPOS="$1"
TXN="$2"

SVNLOOK=/opt/local/bin/svnlook

# Committing to tags is not allowed
$SVNLOOK changed -t "$TXN" "$REPOS" | grep "^U\W.*\/tags\/" && /bin/echo "Cannot commit to tags!" 1>&2 && exit 1

# All checks passed, so allow the commit.
exit 0

Raim的grep模式的唯一问题是它只匹配“标签”,如果它位于你的回购的“根”。由于我在repo中有几个项目,因此编写脚本时允许在标记分支上进行提交。

另外,请确保按照指示chmod + x,否则你会认为b / c提交失败了,但它失败b / c它无法执行预提交钩子,不是因为钩子工作

非常棒,感谢Raim。比所有其他建议更好,更轻,因为它没有依赖!

答案 1 :(得分:16)

这是一个简短的shell脚本,用于防止在创建标记后提交标记:

#!/bin/sh

REPOS="$1"
TXN="$2"

SVNLOOK=/usr/bin/svnlook

# Committing to tags is not allowed
$SVNLOOK changed -t "$TXN" "$REPOS" | grep "^U\W*tags" && /bin/echo "Cannot commit to tags!" 1>&2 && exit 1

# All checks passed, so allow the commit.
exit 0

将此保存在hooks/pre-commit的Subversion存储库中,并使其chmod +x可执行。

答案 2 :(得分:7)

这是我的Windows批处理文件预提交挂钩。如果用户是管理员,则将跳过其他检查。它检查提交消息是否为空,以及提交是否为标记。注意:findstr是其他平台上grep的替代品。

它检查提交是否为标记的方式,首先检查svnlook是否包含“tags /”。然后检查svnlook是否更改匹配“^ A。 tags / [^ /] / $”,这意味着它将检查您是否在标签/下添加新文件夹。

允许用户创建新项目。预提交钩子允许用户创建文件夹trunk / tags /和branches /。不允许用户删除文件夹trunk / tags /和branches /。这适用于单个或多个项目存储库。

 @echo off
 rem This pre-commit hook will block commits with no log messages and blocks commits on tags.
 rem Users may create tags, but not modify them.
 rem If the user is an Administrator the commit will succeed.

 rem Specify the username of the repository administrator
 rem commits by this user are not checked for comments or tags
 rem Recommended to change the Administrator only when an admin commit is neccessary
 rem then reset the Administrator after the admin commit is complete
 rem this way the admin user is only an administrator when neccessary
 set Administrator=Administrator

 setlocal

 rem Subversion sends through the path to the repository and transaction id.
 set REPOS=%1%
 set TXN=%2%

 :Main
 rem check if the user is an Administrator
 svnlook author %REPOS% -t %TXN% | findstr /r "^%Administrator%$" >nul
 if %errorlevel%==0 (exit 0)

 rem Check if the commit has an empty log message
 svnlook log %REPOS% -t %TXN% | findstr . > nul
 if %errorlevel% gtr 0 (goto CommentError)

 rem Block deletion of branches and trunk
 svnlook changed %REPOS% -t %TXN% | findstr /r "^D.*trunk/$ ^D.*branches/$" >nul
 if %errorlevel%==0 (goto DeleteBranchTrunkError)

 rem Check if the commit is to a tag
 svnlook changed %REPOS% -t %TXN% | findstr /r "^.*tags/" >nul
 if %errorlevel%==0 (goto TagCommit)
 exit 0

 :DeleteBranchTrunkError
 echo. 1>&2
 echo Trunk/Branch Delete Error: 1>&2
 echo     Only an Administrator may delete the branches or the trunk. 1>&2
 echo Commit details: 1>&2
 svnlook changed %REPOS% -t %TXN% 1>&2
 exit 1

 :TagCommit
 rem Check if the commit is creating a subdirectory under tags/ (tags/v1.0.0.1)
 svnlook changed %REPOS% -t %TXN% | findstr /r "^A.*tags/[^/]*/$" >nul
 if %errorlevel% gtr 0 (goto CheckCreatingTags)
 exit 0

 :CheckCreatingTags
 rem Check if the commit is creating a tags/ directory
 svnlook changed %REPOS% -t %TXN% | findstr /r "^A.*tags/$" >nul
 if %errorlevel% == 0 (exit 0)
 goto TagsCommitError

 :CommentError
 echo. 1>&2
 echo Comment Error: 1>&2
 echo     Your commit has been blocked because you didn't enter a comment. 1>&2
 echo     Write a log message describing your changes and try again. 1>&2
 exit 1

 :TagsCommitError
 echo. 1>&2
 echo %cd% 1>&2
 echo Tags Commit Error: 1>&2
 echo     Your commit to a tag has been blocked. 1>&2
 echo     You are only allowed to create tags. 1>&2
 echo     Tags may only be modified by an Administrator. 1>&2
 echo Commit details: 1>&2
 svnlook changed %REPOS% -t %TXN% 1>&2
 exit 1

答案 3 :(得分:6)

这个anwser在日期之后很多,但是我发现了svnlook更改命令的--copy-info参数。

此命令的输出在第三列中添加了一个“+”,因此您知道它是一个副本。您可以检查对tags目录的提交,并且只允许提交带有“+”的提交。

我在my blog post中添加了一些输出。

答案 4 :(得分:4)

派对上已经很晚了,但是我写了一个基于http://subversion.tigris.org/上的log-police.py脚本的python预提交钩子。

此脚本应该可以执行您想要的操作,但它也会检查是否存在日志消息,但这应该很容易从脚本中删除。

一些警告:

  • 我是Python新手,所以最有可能写得更好
  • 它仅在Windows 2003上使用Python 2.5和Subversion 1.4进行了测试。

要求:

  • 的Subversion
  • 的Python
  • Python的Subversion绑定

最后,代码:

#!/usr/bin/env python

#
# pre-commit.py:
#
# Performs the following:
#  - Makes sure the author has entered in a log message.
#  - Make sure author is only creating a tag, or if deleting a tag, author is a specific user
#
# Script based on http://svn.collab.net/repos/svn/trunk/tools/hook-scripts/log-police.py
#
# usage: pre-commit.py -t TXN_NAME REPOS
# E.g. in pre-commit.bat (under Windows)
#   python.exe {common_hooks_dir}\pre_commit.py -t %2 %1
#


import os
import sys
import getopt
try:
  my_getopt = getopt.gnu_getopt
except AttributeError:
  my_getopt = getopt.getopt

import re

import svn
import svn.fs
import svn.repos
import svn.core

#
# Check Tags functionality
#
def check_for_tags(txn):
  txn_root = svn.fs.svn_fs_txn_root(txn)
  changed_paths = svn.fs.paths_changed(txn_root)
  for path, change in changed_paths.iteritems():
    if is_path_within_a_tag(path): # else go to next path
      if is_path_a_tag(path):
        if (change.change_kind == svn.fs.path_change_delete):
          if not is_txn_author_allowed_to_delete(txn):
            sys.stderr.write("\nOnly an administrator can delete a tag.\n\nContact your Subversion Administrator for details.")
            return False
        elif (change.change_kind != svn.fs.path_change_add):
          sys.stderr.write("\nUnable to modify " + path + ".\n\nIt is within a tag and tags are read-only.\n\nContact your Subversion Administrator for details.")
          return False
        # else user is adding a tag, so accept this change
      else:
        sys.stderr.write("\nUnable to modify " + path + ".\n\nIt is within a tag and tags are read-only.\n\nContact your Subversion Administrator for details.")
        return False
  return True

def is_path_within_a_tag(path):
  return re.search('(?i)\/tags\/', path)

def is_path_a_tag(path):
  return re.search('(?i)\/tags\/[^\/]+\/?$', path)

def is_txn_author_allowed_to_delete(txn):
  author = get_txn_property(txn, 'svn:author')
  return (author == 'bob.smith')

#
# Check log message functionality
#
def check_log_message(txn):
  log_message = get_txn_property(txn, "svn:log")
  if log_message is None or log_message.strip() == "":
    sys.stderr.write("\nCannot enter in empty commit message.\n")
    return False
  else:
    return True

def get_txn_property(txn, prop_name):
  return svn.fs.svn_fs_txn_prop(txn, prop_name)

def usage_and_exit(error_msg=None):
  import os.path
  stream = error_msg and sys.stderr or sys.stdout
  if error_msg:
    stream.write("ERROR: %s\n\n" % error_msg)
  stream.write("USAGE: %s -t TXN_NAME REPOS\n"
               % (os.path.basename(sys.argv[0])))
  sys.exit(error_msg and 1 or 0)

def main(ignored_pool, argv):
  repos_path = None
  txn_name = None

  try:
    opts, args = my_getopt(argv[1:], 't:h?', ["help"])
  except:
    usage_and_exit("problem processing arguments / options.")
  for opt, value in opts:
    if opt == '--help' or opt == '-h' or opt == '-?':
      usage_and_exit()
    elif opt == '-t':
      txn_name = value
    else:
      usage_and_exit("unknown option '%s'." % opt)

  if txn_name is None:
    usage_and_exit("must provide -t argument")
  if len(args) != 1:
    usage_and_exit("only one argument allowed (the repository).")

  repos_path = svn.core.svn_path_canonicalize(args[0])

  fs = svn.repos.svn_repos_fs(svn.repos.svn_repos_open(repos_path))
  txn = svn.fs.svn_fs_open_txn(fs, txn_name)

  if check_log_message(txn) and check_for_tags(txn):
    sys.exit(0)
  else:
    sys.exit(1)

if __name__ == '__main__':
  sys.exit(svn.core.run_app(main, sys.argv))

答案 5 :(得分:4)

以前编写的大多数脚本都不完整,因为没有涵盖几个案例。这是我的剧本:

contains_tags_dir=`$SVNLOOK changed --copy-info -t "$TXN" "$REPOS" | head -1 | egrep "+\/tags\/.*$" | wc -l | sed "s/ //g"`

if [ $contains_tags_dir -gt 0 ]
then
  tags_dir_creation=`$SVNLOOK changed --copy-info -t "$TXN" "$REPOS" | head -1 | egrep "^A       .+\/tags\/$" | wc -l | sed "s/ //g"`
  if [ $tags_dir_creation -ne 1 ]
  then
    initial_add=`$SVNLOOK changed --copy-info -t "$TXN" "$REPOS" | head -1 | egrep "^A \+ .+\/tags\/.+\/$" | wc -l | sed "s/ //g"`
    if [ $initial_add -ne 1 ]
    then
      echo "Tags cannot be changed!" 1>&2
      exit 1
    fi
  fi
fi

这可能看起来很复杂,但你必须确保你在/tags,如果它不存在,你可以创建/tags和所有后续文件夹。任何其他更改都被阻止。几乎所有以前的脚本都没有涵盖Subversion的svnlook changed ...书中描述的所有案例。

答案 6 :(得分:3)

接受的答案会阻止更新标记中的文件,但不会阻止将文件添加到标记中。以下版本处理两者:

#!/bin/sh

REPOS="$1"
TXN="$2"
SVNLOOK="/home/staging/thirdparty/subversion-1.6.17/bin/svnlook"

# Committing to tags is not allowed
$SVNLOOK changed -t "$TXN" "$REPOS" --copy-info| grep -v "^ " | grep -P '^[AU]   \w+/tags/' && /bin/echo "Cannot update tags!" 1>&2 && exit 1

# All checks passed, so allow the commit.
exit 0

答案 7 :(得分:1)

我的版本只允许创建和删除标签。这应该处理所有特殊情况(如添加文件,更改属性等)。

#!/bin/sh

REPOS="$1"
TXN="$2"
SVNLOOK=/usr/local/bin/svnlook

output_error_and_exit() {
    echo "$1" >&2
    exit 1
}

changed_tags=$( $SVNLOOK changed -t "$TXN" "$REPOS" | grep "[ /]tags/." )

if [ "$changed_tags" ]
then 
    echo "$changed_tags" | egrep -v "^[AD] +(.*/)?tags/[^/]+/$" && output_error_and_exit "Modification of tags is not allowed."
fi 

exit 0

答案 8 :(得分:1)

由于第一个答案没有阻止add / suppr文件,并且阻止了新标签的创建,以及许多其他不完整或有缺陷的文件,我重写了它

这是我的预提交钩子: 目标是:

  • 禁止对标签进行提交(文件添加/抑制/更新)
  • 不要阻止创建标签

--------- file" pre-commit" (放入存储库 hooks 文件夹)---------

#!/bin/sh

REPOS="$1"
TXN="$2"

SVNLOOK=/usr/bin/svnlook

#Logs
#$SVNLOOK changed -t "$TXN" "$REPOS" > /tmp/changes
#echo "$TXN" > /tmp/txn
#echo "$REPOS" > /tmp/repos

# Committing to tags is not allowed
# Forbidden changes are Update/Add/Delete.  /W = non alphanum char  Redirect is necessary to get the error message, since regular output is lost.
# BUT, we must allow tag creation / suppression

$SVNLOOK changed -t "$TXN" "$REPOS" | /bin/grep "^A\W.*tags\/[0-9._-]*\/." && /bin/echo "Commit to tags are NOT allowed ! (Admin custom rule)" 1>&2 && exit 101
$SVNLOOK changed -t "$TXN" "$REPOS" | /bin/grep "^U\W.*tags\/[0-9._-]*\/." && /bin/echo "Commit to tags are NOT allowed ! (Admin custom rule)" 1>&2 && exit 102
$SVNLOOK changed -t "$TXN" "$REPOS" | /bin/grep "^D\W.*tags\/[0-9._-]*\/." && /bin/echo "Commit to tags are NOT allowed ! (Admin custom rule)" 1>&2 && exit 104

# All checks passed, so allow the commit.
exit 0;

---------文件结束"预先提交" ---------

另外,我制作了两个shell脚本来复制我的svn的每个项目中的钩子: 一个只设置回购:

--------- script" setOneRepoTagsReadOnly.sh" ---------

#!/bin/sh

cd /var/svn/repos/svn
zeFileName=$1/hooks/pre-commit
/bin/cp ./CUSTOM_HOOKS/pre-commit $zeFileName
chown www-data:www-data $zeFileName
chmod +x $zeFileName

---------文件结束" setOneRepoTagsReadOnly.sh" ---------

一个人为每个回购电话打电话,让我所有的回购只读:

--------- file" makeTagsReadOnly.sh" ---------

#!/bin/shs/svn                                                                                                                                                                         
#Lists all repos, and adds the pre-commit hook to protect tags on each of them
find /var/svn/repos/svn/ -maxdepth 1 -mindepth 1 -type d -execdir '/var/svn/repos/svn/setOneRepoTagsReadOnly.sh' \{\} \;

---------文件结束" makeTagsReadOnly.sh" ---------

我直接从svn" root"执行脚本。 (/ var / svn / repos / svn,在我的例子中)。 顺便说一句,cron任务可以设置为通过每天执行脚本来自动修改新的repos

希望它有所帮助。

答案 9 :(得分:1)

如果您使用的是JIRA,则可以使用名为Commit Policy的加载项来保护存储库中的路径,而无需编写自定义挂钩

如何?使用名为 Changed files must match a pattern 的条件。

它有一个正则表达式类型参数,必须匹配提交中的每个文件,否则拒绝提交。因此,在您的情况下,您应该使用正则表达式,这意味着"不以前缀/标记/"开头。

(您可以使用相同的插件实现许多其他智能检查。)

免责声明:我是开发此付费插件的开发人员。

答案 10 :(得分:0)

列出的答案很棒,但没有一个完全符合我的要求。我想允许轻松创建标签,但一旦创建它们,它们应该是完全只读的。

我还想防止愚蠢的情况,如果你这样做:

svn copy myrepo/trunk myrepo/tags/newrelease

一切都很好。但第二次,如果标签已经存在,您最终会得到myrepo/tags/newrelease/trunk

我的预提交钩子会查找与(repo)/tags/(tag)/匹配的任何已存在的SVN目录,如果找到则会失败:

$SVNLOOK tree -N --full-paths "$REPOS" "`$SVNLOOK changed -t "$TXN" "$REPOS" \
  | sed 's/[A-Z][[:space:]]*\([^/]*\)\/tags\/\([^/]*\)\/.*/\1\/tags\/\2\//' \
  | head -n 1`" \
  && echo "Tag already exists, commit rejected." >&2 \
  && exit 1