Documentation/hooks.txt

   1 Hooks used by git
   2 =================
   3
   4 Hooks are little scripts you can place in `$GIT_DIR/hooks`
   5 directory to trigger action at certain points.  When
   6 `git-init` is run, a handful example hooks are copied in the
   7 `hooks` directory of the new repository, but by default they are
   8 all disabled.  To enable a hook, make it executable with `chmod +x`.
   9
  10 This document describes the currently defined hooks.
  11
  12 applypatch-msg
  13 --------------
  14
  15 This hook is invoked by `git-applypatch` script, which is
  16 typically invoked by `git-applymbox`.  It takes a single
  17 parameter, the name of the file that holds the proposed commit
  18 log message.  Exiting with non-zero status causes
  19 `git-applypatch` to abort before applying the patch.
  20
  21 The hook is allowed to edit the message file in place, and can
  22 be used to normalize the message into some project standard
  23 format (if the project has one). It can also be used to refuse
  24 the commit after inspecting the message file.
  25
  26 The default 'applypatch-msg' hook, when enabled, runs the
  27 'commit-msg' hook, if the latter is enabled.
  28
  29 pre-applypatch
  30 --------------
  31
  32 This hook is invoked by `git-applypatch` script, which is
  33 typically invoked by `git-applymbox`.  It takes no parameter,
  34 and is invoked after the patch is applied, but before a commit
  35 is made.  Exiting with non-zero status causes the working tree
  36 after application of the patch not committed.
  37
  38 It can be used to inspect the current working tree and refuse to
  39 make a commit if it does not pass certain test.
  40
  41 The default 'pre-applypatch' hook, when enabled, runs the
  42 'pre-commit' hook, if the latter is enabled.
  43
  44 post-applypatch
  45 ---------------
  46
  47 This hook is invoked by `git-applypatch` script, which is
  48 typically invoked by `git-applymbox`.  It takes no parameter,
  49 and is invoked after the patch is applied and a commit is made.
  50
  51 This hook is meant primarily for notification, and cannot affect
  52 the outcome of `git-applypatch`.
  53
  54 pre-commit
  55 ----------
  56
  57 This hook is invoked by `git-commit`, and can be bypassed
  58 with `\--no-verify` option.  It takes no parameter, and is
  59 invoked before obtaining the proposed commit log message and
  60 making a commit.  Exiting with non-zero status from this script
  61 causes the `git-commit` to abort.
  62
  63 The default 'pre-commit' hook, when enabled, catches introduction
  64 of lines with trailing whitespaces and aborts the commit when
  65 such a line is found.
  66
  67 commit-msg
  68 ----------
  69
  70 This hook is invoked by `git-commit`, and can be bypassed
  71 with `\--no-verify` option.  It takes a single parameter, the
  72 name of the file that holds the proposed commit log message.
  73 Exiting with non-zero status causes the `git-commit` to
  74 abort.
  75
  76 The hook is allowed to edit the message file in place, and can
  77 be used to normalize the message into some project standard
  78 format (if the project has one). It can also be used to refuse
  79 the commit after inspecting the message file.
  80
  81 The default 'commit-msg' hook, when enabled, detects duplicate
  82 "Signed-off-by" lines, and aborts the commit if one is found.
  83
  84 post-commit
  85 -----------
  86
  87 This hook is invoked by `git-commit`.  It takes no
  88 parameter, and is invoked after a commit is made.
  89
  90 This hook is meant primarily for notification, and cannot affect
  91 the outcome of `git-commit`.
  92
  93 [[pre-receive]]
  94 pre-receive
  95 -----------
  96
  97 This hook is invoked by `git-receive-pack` on the remote repository,
  98 which happens when a `git push` is done on a local repository.
  99 Just before starting to update refs on the remote repository, the
 100 pre-receive hook is invoked.  Its exit status determines the success
 101 or failure of the update.
 102
 103 This hook executes once for the receive operation. It takes no
 104 arguments, but for each ref to be updated it receives on standard
 105 input a line of the format:
 106
 107   <old-value> SP <new-value> SP <ref-name> LF
 108
 109 where `<old-value>` is the old object name stored in the ref,
 110 `<new-value>` is the new object name to be stored in the ref and
 111 `<ref-name>` is the full name of the ref.
 112 When creating a new ref, `<old-value>` is 40 `0`.
 113
 114 If the hook exits with non-zero status, none of the refs will be
 115 updated. If the hook exits with zero, updating of individual refs can
 116 still be prevented by the <<update,'update'>> hook.
 117
 118 If you want to report something to the `git-send-pack` on the other end,
 119 you can simply `echo` your messages.
 120
 121 [[update]]
 122 update
 123 ------
 124
 125 This hook is invoked by `git-receive-pack` on the remote repository,
 126 which happens when a `git push` is done on a local repository.
 127 Just before updating the ref on the remote repository, the update hook
 128 is invoked.  Its exit status determines the success or failure of
 129 the ref update.
 130
 131 The hook executes once for each ref to be updated, and takes
 132 three parameters:
 133
 134  - the name of the ref being updated,
 135  - the old object name stored in the ref,
 136  - and the new objectname to be stored in the ref.
 137
 138 A zero exit from the update hook allows the ref to be updated.
 139 Exiting with a non-zero status prevents `git-receive-pack`
 140 from updating that ref.
 141
 142 This hook can be used to prevent 'forced' update on certain refs by
 143 making sure that the object name is a commit object that is a
 144 descendant of the commit object named by the old object name.
 145 That is, to enforce a "fast forward only" policy.
 146
 147 It could also be used to log the old..new status.  However, it
 148 does not know the entire set of branches, so it would end up
 149 firing one e-mail per ref when used naively, though.  The
 150 <<post-receive,'post-receive'>> hook is more suited to that.
 151
 152 Another use suggested on the mailing list is to use this hook to
 153 implement access control which is finer grained than the one
 154 based on filesystem group.
 155
 156 The standard output of this hook is sent to `stderr`, so if you
 157 want to report something to the `git-send-pack` on the other end,
 158 you can simply `echo` your messages.
 159
 160 The default 'update' hook, when enabled--and with
 161 `hooks.allowunannotated` config option turned on--prevents
 162 unannotated tags to be pushed.
 163
 164 [[post-receive]]
 165 post-receive
 166 ------------
 167
 168 This hook is invoked by `git-receive-pack` on the remote repository,
 169 which happens when a `git push` is done on a local repository.
 170 It executes on the remote repository once after all the refs have
 171 been updated.
 172
 173 This hook executes once for the receive operation.  It takes no
 174 arguments, but gets the same information as the `pre-receive`
 175 hook does on its standard input.
 176
 177 This hook does not affect the outcome of `git-receive-pack`, as it
 178 is called after the real work is done.
 179
 180 This supersedes the [[post-update]] hook in that it actually get's
 181 both old and new values of all the refs.
 182
 183 If you want to report something to the `git-send-pack` on the
 184 other end, you can simply `echo` your messages.
 185
 186 The default 'post-receive' hook is empty, but there is
 187 a sample script `post-receive-email` provided in the `contrib/hooks`
 188 directory in git distribution, which implements sending commit
 189 emails.
 190
 191 [[post-update]]
 192 post-update
 193 -----------
 194
 195 This hook is invoked by `git-receive-pack` on the remote repository,
 196 which happens when a `git push` is done on a local repository.
 197 It executes on the remote repository once after all the refs have
 198 been updated.
 199
 200 It takes a variable number of parameters, each of which is the
 201 name of ref that was actually updated.
 202
 203 This hook is meant primarily for notification, and cannot affect
 204 the outcome of `git-receive-pack`.
 205
 206 The 'post-update' hook can tell what are the heads that were pushed,
 207 but it does not know what their original and updated values are,
 208 so it is a poor place to do log old..new.
 209
 210 In general, `post-receive` hook is preferred when the hook needs
 211 to decide its acion on the status of the entire set of refs
 212 being updated, as this hook is called once per ref, with
 213 information only on a single ref at a time.
 214
 215 When enabled, the default 'post-update' hook runs
 216 `git-update-server-info` to keep the information used by dumb
 217 transports (e.g., HTTP) up-to-date.  If you are publishing
 218 a git repository that is accessible via HTTP, you should
 219 probably enable this hook.
 220
 221 Both standard output and standard error output are forwarded to
 222 `git-send-pack` on the other end.