6 githooks - Hooks used by Git
10 $GIT_DIR/hooks/* (or \`git config core.hooksPath`/*)
16 Hooks are programs you can place in a hooks directory to trigger
17 actions at certain points in git's execution. Hooks that don't have
18 the executable bit set are ignored.
20 By default the hooks directory is `$GIT_DIR/hooks`, but that can be
21 changed via the `core.hooksPath` configuration variable (see
22 linkgit:git-config[1]).
24 Before Git invokes a hook, it changes its working directory to either
25 $GIT_DIR in a bare repository or the root of the working tree in a non-bare
26 repository. An exception are hooks triggered during a push ('pre-receive',
27 'update', 'post-receive', 'post-update', 'push-to-checkout') which are always
30 Hooks can get their arguments via the environment, command-line
31 arguments, and stdin. See the documentation for each hook below for
34 `git init` may copy hooks to the new repository, depending on its
35 configuration. See the "TEMPLATE DIRECTORY" section in
36 linkgit:git-init[1] for details. When the rest of this document refers
37 to "default hooks" it's talking about the default template shipped
40 The currently supported hooks are described below.
48 This hook is invoked by linkgit:git-am[1]. It takes a single
49 parameter, the name of the file that holds the proposed commit
50 log message. Exiting with a non-zero status causes `git am` to abort
51 before applying the patch.
53 The hook is allowed to edit the message file in place, and can
54 be used to normalize the message into some project standard
55 format. It can also be used to refuse the commit after inspecting
58 The default 'applypatch-msg' hook, when enabled, runs the
59 'commit-msg' hook, if the latter is enabled.
64 This hook is invoked by linkgit:git-am[1]. It takes no parameter, and is
65 invoked after the patch is applied, but before a commit is made.
67 If it exits with non-zero status, then the working tree will not be
68 committed after applying the patch.
70 It can be used to inspect the current working tree and refuse to
71 make a commit if it does not pass certain test.
73 The default 'pre-applypatch' hook, when enabled, runs the
74 'pre-commit' hook, if the latter is enabled.
79 This hook is invoked by linkgit:git-am[1]. It takes no parameter,
80 and is invoked after the patch is applied and a commit is made.
82 This hook is meant primarily for notification, and cannot affect
83 the outcome of `git am`.
88 This hook is invoked by linkgit:git-commit[1], and can be bypassed
89 with the `--no-verify` option. It takes no parameters, and is
90 invoked before obtaining the proposed commit log message and
91 making a commit. Exiting with a non-zero status from this script
92 causes the `git commit` command to abort before creating a commit.
94 The default 'pre-commit' hook, when enabled, catches introduction
95 of lines with trailing whitespaces and aborts the commit when
98 All the `git commit` hooks are invoked with the environment
99 variable `GIT_EDITOR=:` if the command will not bring up an editor
100 to modify the commit message.
102 The default 'pre-commit' hook, when enabled--and with the
103 `hooks.allownonascii` config option unset or set to false--prevents
104 the use of non-ASCII filenames.
109 This hook is invoked by linkgit:git-merge[1]. It takes no parameters, and is
110 invoked after the merge has been carried out successfully and before
111 obtaining the proposed commit log message to
112 make a commit. Exiting with a non-zero status from this script
113 causes the `git merge` command to abort before creating a commit.
115 The default 'pre-merge-commit' hook, when enabled, runs the
116 'pre-commit' hook, if the latter is enabled.
118 This hook is invoked with the environment variable
119 `GIT_EDITOR=:` if the command will not bring up an editor
120 to modify the commit message.
122 If the merge cannot be carried out automatically, the conflicts
123 need to be resolved and the result committed separately (see
124 linkgit:git-merge[1]). At that point, this hook will not be executed,
125 but the 'pre-commit' hook will, if it is enabled.
130 This hook is invoked by linkgit:git-commit[1] right after preparing the
131 default log message, and before the editor is started.
133 It takes one to three parameters. The first is the name of the file
134 that contains the commit log message. The second is the source of the commit
135 message, and can be: `message` (if a `-m` or `-F` option was
136 given); `template` (if a `-t` option was given or the
137 configuration option `commit.template` is set); `merge` (if the
138 commit is a merge or a `.git/MERGE_MSG` file exists); `squash`
139 (if a `.git/SQUASH_MSG` file exists); or `commit`, followed by
140 a commit SHA-1 (if a `-c`, `-C` or `--amend` option was given).
142 If the exit status is non-zero, `git commit` will abort.
144 The purpose of the hook is to edit the message file in place, and
145 it is not suppressed by the `--no-verify` option. A non-zero exit
146 means a failure of the hook and aborts the commit. It should not
147 be used as replacement for pre-commit hook.
149 The sample `prepare-commit-msg` hook that comes with Git removes the
150 help message found in the commented portion of the commit template.
155 This hook is invoked by linkgit:git-commit[1] and linkgit:git-merge[1], and can be
156 bypassed with the `--no-verify` option. It takes a single parameter,
157 the name of the file that holds the proposed commit log message.
158 Exiting with a non-zero status causes the command to abort.
160 The hook is allowed to edit the message file in place, and can be used
161 to normalize the message into some project standard format. It
162 can also be used to refuse the commit after inspecting the message
165 The default 'commit-msg' hook, when enabled, detects duplicate
166 "Signed-off-by" lines, and aborts the commit if one is found.
171 This hook is invoked by linkgit:git-commit[1]. It takes no parameters, and is
172 invoked after a commit is made.
174 This hook is meant primarily for notification, and cannot affect
175 the outcome of `git commit`.
180 This hook is called by linkgit:git-rebase[1] and can be used to prevent a
181 branch from getting rebased. The hook may be called with one or
182 two parameters. The first parameter is the upstream from which
183 the series was forked. The second parameter is the branch being
184 rebased, and is not set when rebasing the current branch.
189 This hook is invoked when a linkgit:git-checkout[1] or
190 linkgit:git-switch[1] is run after having updated the
191 worktree. The hook is given three parameters: the ref of the previous HEAD,
192 the ref of the new HEAD (which may or may not have changed), and a flag
193 indicating whether the checkout was a branch checkout (changing branches,
194 flag=1) or a file checkout (retrieving a file from the index, flag=0).
195 This hook cannot affect the outcome of `git switch` or `git checkout`.
197 It is also run after linkgit:git-clone[1], unless the `--no-checkout` (`-n`) option is
198 used. The first parameter given to the hook is the null-ref, the second the
199 ref of the new HEAD and the flag is always 1. Likewise for `git worktree add`
200 unless `--no-checkout` is used.
202 This hook can be used to perform repository validity checks, auto-display
203 differences from the previous HEAD if different, or set working dir metadata
209 This hook is invoked by linkgit:git-merge[1], which happens when a `git pull`
210 is done on a local repository. The hook takes a single parameter, a status
211 flag specifying whether or not the merge being done was a squash merge.
212 This hook cannot affect the outcome of `git merge` and is not executed,
213 if the merge failed due to conflicts.
215 This hook can be used in conjunction with a corresponding pre-commit hook to
216 save and restore any form of metadata associated with the working tree
217 (e.g.: permissions/ownership, ACLS, etc). See contrib/hooks/setgitperms.perl
218 for an example of how to do this.
223 This hook is called by linkgit:git-push[1] and can be used to prevent
224 a push from taking place. The hook is called with two parameters
225 which provide the name and location of the destination remote, if a
226 named remote is not being used both values will be the same.
228 Information about what is to be pushed is provided on the hook's standard
229 input with lines of the form:
231 <local ref> SP <local sha1> SP <remote ref> SP <remote sha1> LF
233 For instance, if the command +git push origin master:foreign+ were run the
234 hook would receive a line like the following:
236 refs/heads/master 67890 refs/heads/foreign 12345
238 although the full, 40-character SHA-1s would be supplied. If the foreign ref
239 does not yet exist the `<remote SHA-1>` will be 40 `0`. If a ref is to be
240 deleted, the `<local ref>` will be supplied as `(delete)` and the `<local
241 SHA-1>` will be 40 `0`. If the local commit was specified by something other
242 than a name which could be expanded (such as `HEAD~`, or a SHA-1) it will be
243 supplied as it was originally given.
245 If this hook exits with a non-zero status, `git push` will abort without
246 pushing anything. Information about why the push is rejected may be sent
247 to the user by writing to standard error.
253 This hook is invoked by linkgit:git-receive-pack[1] when it reacts to
254 `git push` and updates reference(s) in its repository.
255 Just before starting to update refs on the remote repository, the
256 pre-receive hook is invoked. Its exit status determines the success
257 or failure of the update.
259 This hook executes once for the receive operation. It takes no
260 arguments, but for each ref to be updated it receives on standard
261 input a line of the format:
263 <old-value> SP <new-value> SP <ref-name> LF
265 where `<old-value>` is the old object name stored in the ref,
266 `<new-value>` is the new object name to be stored in the ref and
267 `<ref-name>` is the full name of the ref.
268 When creating a new ref, `<old-value>` is 40 `0`.
270 If the hook exits with non-zero status, none of the refs will be
271 updated. If the hook exits with zero, updating of individual refs can
272 still be prevented by the <<update,'update'>> hook.
274 Both standard output and standard error output are forwarded to
275 `git send-pack` on the other end, so you can simply `echo` messages
278 The number of push options given on the command line of
279 `git push --push-option=...` can be read from the environment
280 variable `GIT_PUSH_OPTION_COUNT`, and the options themselves are
281 found in `GIT_PUSH_OPTION_0`, `GIT_PUSH_OPTION_1`,...
282 If it is negotiated to not use the push options phase, the
283 environment variables will not be set. If the client selects
284 to use push options, but doesn't transmit any, the count variable
285 will be set to zero, `GIT_PUSH_OPTION_COUNT=0`.
287 See the section on "Quarantine Environment" in
288 linkgit:git-receive-pack[1] for some caveats.
294 This hook is invoked by linkgit:git-receive-pack[1] when it reacts to
295 `git push` and updates reference(s) in its repository.
296 Just before updating the ref on the remote repository, the update hook
297 is invoked. Its exit status determines the success or failure of
300 The hook executes once for each ref to be updated, and takes
303 - the name of the ref being updated,
304 - the old object name stored in the ref,
305 - and the new object name to be stored in the ref.
307 A zero exit from the update hook allows the ref to be updated.
308 Exiting with a non-zero status prevents `git receive-pack`
309 from updating that ref.
311 This hook can be used to prevent 'forced' update on certain refs by
312 making sure that the object name is a commit object that is a
313 descendant of the commit object named by the old object name.
314 That is, to enforce a "fast-forward only" policy.
316 It could also be used to log the old..new status. However, it
317 does not know the entire set of branches, so it would end up
318 firing one e-mail per ref when used naively, though. The
319 <<post-receive,'post-receive'>> hook is more suited to that.
321 In an environment that restricts the users' access only to git
322 commands over the wire, this hook can be used to implement access
323 control without relying on filesystem ownership and group
324 membership. See linkgit:git-shell[1] for how you might use the login
325 shell to restrict the user's access to only git commands.
327 Both standard output and standard error output are forwarded to
328 `git send-pack` on the other end, so you can simply `echo` messages
331 The default 'update' hook, when enabled--and with
332 `hooks.allowunannotated` config option unset or set to false--prevents
333 unannotated tags to be pushed.
339 This hook is invoked by linkgit:git-receive-pack[1] when it reacts to
340 `git push` and updates reference(s) in its repository.
341 It executes on the remote repository once after all the refs have
344 This hook executes once for the receive operation. It takes no
345 arguments, but gets the same information as the
346 <<pre-receive,'pre-receive'>>
347 hook does on its standard input.
349 This hook does not affect the outcome of `git receive-pack`, as it
350 is called after the real work is done.
352 This supersedes the <<post-update,'post-update'>> hook in that it gets
353 both old and new values of all the refs in addition to their
356 Both standard output and standard error output are forwarded to
357 `git send-pack` on the other end, so you can simply `echo` messages
360 The default 'post-receive' hook is empty, but there is
361 a sample script `post-receive-email` provided in the `contrib/hooks`
362 directory in Git distribution, which implements sending commit
365 The number of push options given on the command line of
366 `git push --push-option=...` can be read from the environment
367 variable `GIT_PUSH_OPTION_COUNT`, and the options themselves are
368 found in `GIT_PUSH_OPTION_0`, `GIT_PUSH_OPTION_1`,...
369 If it is negotiated to not use the push options phase, the
370 environment variables will not be set. If the client selects
371 to use push options, but doesn't transmit any, the count variable
372 will be set to zero, `GIT_PUSH_OPTION_COUNT=0`.
378 This hook is invoked by linkgit:git-receive-pack[1] when it reacts to
379 `git push` and updates reference(s) in its repository.
380 It executes on the remote repository once after all the refs have
383 It takes a variable number of parameters, each of which is the
384 name of ref that was actually updated.
386 This hook is meant primarily for notification, and cannot affect
387 the outcome of `git receive-pack`.
389 The 'post-update' hook can tell what are the heads that were pushed,
390 but it does not know what their original and updated values are,
391 so it is a poor place to do log old..new. The
392 <<post-receive,'post-receive'>> hook does get both original and
393 updated values of the refs. You might consider it instead if you need
396 When enabled, the default 'post-update' hook runs
397 `git update-server-info` to keep the information used by dumb
398 transports (e.g., HTTP) up to date. If you are publishing
399 a Git repository that is accessible via HTTP, you should
400 probably enable this hook.
402 Both standard output and standard error output are forwarded to
403 `git send-pack` on the other end, so you can simply `echo` messages
409 This hook is invoked by linkgit:git-receive-pack[1] when it reacts to
410 `git push` and updates reference(s) in its repository, and when
411 the push tries to update the branch that is currently checked out
412 and the `receive.denyCurrentBranch` configuration variable is set to
413 `updateInstead`. Such a push by default is refused if the working
414 tree and the index of the remote repository has any difference from
415 the currently checked out commit; when both the working tree and the
416 index match the current commit, they are updated to match the newly
417 pushed tip of the branch. This hook is to be used to override the
420 The hook receives the commit with which the tip of the current
421 branch is going to be updated. It can exit with a non-zero status
422 to refuse the push (when it does so, it must not modify the index or
423 the working tree). Or it can make any necessary changes to the
424 working tree and to the index to bring them to the desired state
425 when the tip of the current branch is updated to the new commit, and
426 exit with a zero status.
428 For example, the hook can simply run `git read-tree -u -m HEAD "$1"`
429 in order to emulate `git fetch` that is run in the reverse direction
430 with `git push`, as the two-tree form of `git read-tree -u -m` is
431 essentially the same as `git switch` or `git checkout`
432 that switches branches while
433 keeping the local changes in the working tree that do not interfere
434 with the difference between the branches.
440 This hook is invoked by `git gc --auto` (see linkgit:git-gc[1]). It
441 takes no parameter, and exiting with non-zero status from this script
442 causes the `git gc --auto` to abort.
447 This hook is invoked by commands that rewrite commits
448 (linkgit:git-commit[1] when called with `--amend` and
449 linkgit:git-rebase[1]; currently `git filter-branch` does 'not' call
450 it!). Its first argument denotes the command it was invoked by:
451 currently one of `amend` or `rebase`. Further command-dependent
452 arguments may be passed in the future.
454 The hook receives a list of the rewritten commits on stdin, in the
457 <old-sha1> SP <new-sha1> [ SP <extra-info> ] LF
459 The 'extra-info' is again command-dependent. If it is empty, the
460 preceding SP is also omitted. Currently, no commands pass any
463 The hook always runs after the automatic note copying (see
464 "notes.rewrite.<command>" in linkgit:git-config[1]) has happened, and
465 thus has access to these notes.
467 The following command-specific comments apply:
470 For the 'squash' and 'fixup' operation, all commits that were
471 squashed are listed as being rewritten to the squashed commit.
472 This means that there will be several lines sharing the same
475 The commits are guaranteed to be listed in the order that they were
481 This hook is invoked by linkgit:git-send-email[1]. It takes a single parameter,
482 the name of the file that holds the e-mail to be sent. Exiting with a
483 non-zero status causes `git send-email` to abort before sending any
489 This hook is invoked when the configuration option `core.fsmonitor` is
490 set to `.git/hooks/fsmonitor-watchman`. It takes two arguments, a version
491 (currently 1) and the time in elapsed nanoseconds since midnight,
494 The hook should output to stdout the list of all files in the working
495 directory that may have changed since the requested time. The logic
496 should be inclusive so that it does not miss any potential changes.
497 The paths should be relative to the root of the working directory
498 and be separated by a single NUL.
500 It is OK to include files which have not actually changed. All changes
501 including newly-created and deleted files should be included. When
502 files are renamed, both the old and the new name should be included.
504 Git will limit what files it checks for changes as well as which
505 directories are checked for untracked files based on the path names
508 An optimized way to tell git "all files have changed" is to return
511 The exit status determines whether git will use the data from the
512 hook to limit its search. On error, it will fall back to verifying
513 all files and folders.
518 This hook is invoked by `git-p4 submit`. It takes no parameters and nothing
519 from standard input. Exiting with non-zero status from this script prevent
520 `git-p4 submit` from launching. Run `git-p4 submit --help` for details.
525 This hook is invoked when the index is written in read-cache.c
526 do_write_locked_index.
528 The first parameter passed to the hook is the indicator for the
529 working directory being updated. "1" meaning working directory
530 was updated or "0" when the working directory was not updated.
532 The second parameter passed to the hook is the indicator for whether
533 or not the index was updated and the skip-worktree bit could have
534 changed. "1" meaning skip-worktree bits could have been updated
535 and "0" meaning they were not.
537 Only one parameter should be set to "1" when the hook runs. The hook
538 running passing "1", "1" should not be possible.
542 Part of the linkgit:git[1] suite