hooks/post-unlock.tmpl

   1 #!/bin/sh\r
   2 \r
   3 # POST-UNLOCK HOOK\r
   4 #\r
   5 # The post-unlock hook runs after a path is unlocked.  Subversion runs\r
   6 # this hook by invoking a program (script, executable, binary, etc.)\r
   7 # named 'post-unlock' (for which this file is a template) with the \r
   8 # following ordered arguments:\r
   9 #\r
  10 #   [1] REPOS-PATH   (the path to this repository)\r
  11 #   [2] USER         (the user who destroyed the lock)\r
  12 #\r
  13 # The paths that were just unlocked are passed to the hook via STDIN\r
  14 # (as of Subversion 1.2, only one path is passed per invocation, but\r
  15 # the plan is to pass all unlocked paths at once, so the hook program\r
  16 # should be written accordingly).\r
  17 #\r
  18 # The default working directory for the invocation is undefined, so\r
  19 # the program should set one explicitly if it cares.\r
  20 #\r
  21 # Because the lock has already been destroyed and cannot be undone,\r
  22 # the exit code of the hook program is ignored.\r
  23 #\r
  24 # On a Unix system, the normal procedure is to have 'post-unlock'\r
  25 # invoke other programs to do the real work, though it may do the\r
  26 # work itself too.\r
  27 #\r
  28 # Note that 'post-unlock' must be executable by the user(s) who will\r
  29 # invoke it (typically the user httpd runs as), and that user must\r
  30 # have filesystem-level permission to access the repository.\r
  31 #\r
  32 # On a Windows system, you should name the hook program\r
  33 # 'post-unlock.bat' or 'post-unlock.exe',\r
  34 # but the basic idea is the same.\r
  35 # \r
  36 # Here is an example hook script, for a Unix /bin/sh interpreter:\r
  37 \r
  38 REPOS="$1"\r
  39 USER="$2"\r
  40 \r
  41 # Send email to interested parties, let them know a lock was removed:\r
  42 mailer.py unlock "$REPOS" "$USER" /path/to/mailer.conf\r