]>
Commit | Line | Data |
---|---|---|
1 | githooks(5) | |
2 | =========== | |
3 | ||
4 | NAME | |
5 | ---- | |
6 | githooks - Hooks used by Git | |
7 | ||
8 | SYNOPSIS | |
9 | -------- | |
10 | $GIT_DIR/hooks/* | |
11 | ||
12 | ||
13 | DESCRIPTION | |
14 | ----------- | |
15 | ||
16 | Hooks are little scripts you can place in `$GIT_DIR/hooks` | |
17 | directory to trigger action at certain points. When | |
18 | 'git init' is run, a handful of example hooks are copied into the | |
19 | `hooks` directory of the new repository, but by default they are | |
20 | all disabled. To enable a hook, rename it by removing its `.sample` | |
21 | suffix. | |
22 | ||
23 | NOTE: It is also a requirement for a given hook to be executable. | |
24 | However - in a freshly initialized repository - the `.sample` files are | |
25 | executable by default. | |
26 | ||
27 | This document describes the currently defined hooks. | |
28 | ||
29 | HOOKS | |
30 | ----- | |
31 | ||
32 | applypatch-msg | |
33 | ~~~~~~~~~~~~~~ | |
34 | ||
35 | This hook is invoked by 'git am' script. It takes a single | |
36 | parameter, the name of the file that holds the proposed commit | |
37 | log message. Exiting with non-zero status causes | |
38 | 'git am' to abort before applying the patch. | |
39 | ||
40 | The hook is allowed to edit the message file in place, and can | |
41 | be used to normalize the message into some project standard | |
42 | format (if the project has one). It can also be used to refuse | |
43 | the commit after inspecting the message file. | |
44 | ||
45 | The default 'applypatch-msg' hook, when enabled, runs the | |
46 | 'commit-msg' hook, if the latter is enabled. | |
47 | ||
48 | pre-applypatch | |
49 | ~~~~~~~~~~~~~~ | |
50 | ||
51 | This hook is invoked by 'git am'. It takes no parameter, and is | |
52 | invoked after the patch is applied, but before a commit is made. | |
53 | ||
54 | If it exits with non-zero status, then the working tree will not be | |
55 | committed after applying the patch. | |
56 | ||
57 | It can be used to inspect the current working tree and refuse to | |
58 | make a commit if it does not pass certain test. | |
59 | ||
60 | The default 'pre-applypatch' hook, when enabled, runs the | |
61 | 'pre-commit' hook, if the latter is enabled. | |
62 | ||
63 | post-applypatch | |
64 | ~~~~~~~~~~~~~~~ | |
65 | ||
66 | This hook is invoked by 'git am'. It takes no parameter, | |
67 | and is invoked after the patch is applied and a commit is made. | |
68 | ||
69 | This hook is meant primarily for notification, and cannot affect | |
70 | the outcome of 'git am'. | |
71 | ||
72 | pre-commit | |
73 | ~~~~~~~~~~ | |
74 | ||
75 | This hook is invoked by 'git commit', and can be bypassed | |
76 | with `--no-verify` option. It takes no parameter, and is | |
77 | invoked before obtaining the proposed commit log message and | |
78 | making a commit. Exiting with non-zero status from this script | |
79 | causes the 'git commit' to abort. | |
80 | ||
81 | The default 'pre-commit' hook, when enabled, catches introduction | |
82 | of lines with trailing whitespaces and aborts the commit when | |
83 | such a line is found. | |
84 | ||
85 | All the 'git commit' hooks are invoked with the environment | |
86 | variable `GIT_EDITOR=:` if the command will not bring up an editor | |
87 | to modify the commit message. | |
88 | ||
89 | prepare-commit-msg | |
90 | ~~~~~~~~~~~~~~~~~~ | |
91 | ||
92 | This hook is invoked by 'git commit' right after preparing the | |
93 | default log message, and before the editor is started. | |
94 | ||
95 | It takes one to three parameters. The first is the name of the file | |
96 | that contains the commit log message. The second is the source of the commit | |
97 | message, and can be: `message` (if a `-m` or `-F` option was | |
98 | given); `template` (if a `-t` option was given or the | |
99 | configuration option `commit.template` is set); `merge` (if the | |
100 | commit is a merge or a `.git/MERGE_MSG` file exists); `squash` | |
101 | (if a `.git/SQUASH_MSG` file exists); or `commit`, followed by | |
102 | a commit SHA1 (if a `-c`, `-C` or `--amend` option was given). | |
103 | ||
104 | If the exit status is non-zero, 'git commit' will abort. | |
105 | ||
106 | The purpose of the hook is to edit the message file in place, and | |
107 | it is not suppressed by the `--no-verify` option. A non-zero exit | |
108 | means a failure of the hook and aborts the commit. It should not | |
109 | be used as replacement for pre-commit hook. | |
110 | ||
111 | The sample `prepare-commit-msg` hook that comes with Git comments | |
112 | out the `Conflicts:` part of a merge's commit message. | |
113 | ||
114 | commit-msg | |
115 | ~~~~~~~~~~ | |
116 | ||
117 | This hook is invoked by 'git commit', and can be bypassed | |
118 | with `--no-verify` option. It takes a single parameter, the | |
119 | name of the file that holds the proposed commit log message. | |
120 | Exiting with non-zero status causes the 'git commit' to | |
121 | abort. | |
122 | ||
123 | The hook is allowed to edit the message file in place, and can | |
124 | be used to normalize the message into some project standard | |
125 | format (if the project has one). It can also be used to refuse | |
126 | the commit after inspecting the message file. | |
127 | ||
128 | The default 'commit-msg' hook, when enabled, detects duplicate | |
129 | "Signed-off-by" lines, and aborts the commit if one is found. | |
130 | ||
131 | post-commit | |
132 | ~~~~~~~~~~~ | |
133 | ||
134 | This hook is invoked by 'git commit'. It takes no | |
135 | parameter, and is invoked after a commit is made. | |
136 | ||
137 | This hook is meant primarily for notification, and cannot affect | |
138 | the outcome of 'git commit'. | |
139 | ||
140 | pre-rebase | |
141 | ~~~~~~~~~~ | |
142 | ||
143 | This hook is called by 'git rebase' and can be used to prevent a branch | |
144 | from getting rebased. | |
145 | ||
146 | ||
147 | post-checkout | |
148 | ~~~~~~~~~~~~~ | |
149 | ||
150 | This hook is invoked when a 'git checkout' is run after having updated the | |
151 | worktree. The hook is given three parameters: the ref of the previous HEAD, | |
152 | the ref of the new HEAD (which may or may not have changed), and a flag | |
153 | indicating whether the checkout was a branch checkout (changing branches, | |
154 | flag=1) or a file checkout (retrieving a file from the index, flag=0). | |
155 | This hook cannot affect the outcome of 'git checkout'. | |
156 | ||
157 | It is also run after 'git clone', unless the --no-checkout (-n) option is | |
158 | used. The first parameter given to the hook is the null-ref, the second the | |
159 | ref of the new HEAD and the flag is always 1. | |
160 | ||
161 | This hook can be used to perform repository validity checks, auto-display | |
162 | differences from the previous HEAD if different, or set working dir metadata | |
163 | properties. | |
164 | ||
165 | post-merge | |
166 | ~~~~~~~~~~ | |
167 | ||
168 | This hook is invoked by 'git merge', which happens when a 'git pull' | |
169 | is done on a local repository. The hook takes a single parameter, a status | |
170 | flag specifying whether or not the merge being done was a squash merge. | |
171 | This hook cannot affect the outcome of 'git merge' and is not executed, | |
172 | if the merge failed due to conflicts. | |
173 | ||
174 | This hook can be used in conjunction with a corresponding pre-commit hook to | |
175 | save and restore any form of metadata associated with the working tree | |
176 | (eg: permissions/ownership, ACLS, etc). See contrib/hooks/setgitperms.perl | |
177 | for an example of how to do this. | |
178 | ||
179 | [[pre-receive]] | |
180 | pre-receive | |
181 | ~~~~~~~~~~~ | |
182 | ||
183 | This hook is invoked by 'git-receive-pack' on the remote repository, | |
184 | which happens when a 'git push' is done on a local repository. | |
185 | Just before starting to update refs on the remote repository, the | |
186 | pre-receive hook is invoked. Its exit status determines the success | |
187 | or failure of the update. | |
188 | ||
189 | This hook executes once for the receive operation. It takes no | |
190 | arguments, but for each ref to be updated it receives on standard | |
191 | input a line of the format: | |
192 | ||
193 | <old-value> SP <new-value> SP <ref-name> LF | |
194 | ||
195 | where `<old-value>` is the old object name stored in the ref, | |
196 | `<new-value>` is the new object name to be stored in the ref and | |
197 | `<ref-name>` is the full name of the ref. | |
198 | When creating a new ref, `<old-value>` is 40 `0`. | |
199 | ||
200 | If the hook exits with non-zero status, none of the refs will be | |
201 | updated. If the hook exits with zero, updating of individual refs can | |
202 | still be prevented by the <<update,'update'>> hook. | |
203 | ||
204 | Both standard output and standard error output are forwarded to | |
205 | 'git send-pack' on the other end, so you can simply `echo` messages | |
206 | for the user. | |
207 | ||
208 | [[update]] | |
209 | update | |
210 | ~~~~~~ | |
211 | ||
212 | This hook is invoked by 'git-receive-pack' on the remote repository, | |
213 | which happens when a 'git push' is done on a local repository. | |
214 | Just before updating the ref on the remote repository, the update hook | |
215 | is invoked. Its exit status determines the success or failure of | |
216 | the ref update. | |
217 | ||
218 | The hook executes once for each ref to be updated, and takes | |
219 | three parameters: | |
220 | ||
221 | - the name of the ref being updated, | |
222 | - the old object name stored in the ref, | |
223 | - and the new objectname to be stored in the ref. | |
224 | ||
225 | A zero exit from the update hook allows the ref to be updated. | |
226 | Exiting with a non-zero status prevents 'git-receive-pack' | |
227 | from updating that ref. | |
228 | ||
229 | This hook can be used to prevent 'forced' update on certain refs by | |
230 | making sure that the object name is a commit object that is a | |
231 | descendant of the commit object named by the old object name. | |
232 | That is, to enforce a "fast-forward only" policy. | |
233 | ||
234 | It could also be used to log the old..new status. However, it | |
235 | does not know the entire set of branches, so it would end up | |
236 | firing one e-mail per ref when used naively, though. The | |
237 | <<post-receive,'post-receive'>> hook is more suited to that. | |
238 | ||
239 | Another use suggested on the mailing list is to use this hook to | |
240 | implement access control which is finer grained than the one | |
241 | based on filesystem group. | |
242 | ||
243 | Both standard output and standard error output are forwarded to | |
244 | 'git send-pack' on the other end, so you can simply `echo` messages | |
245 | for the user. | |
246 | ||
247 | The default 'update' hook, when enabled--and with | |
248 | `hooks.allowunannotated` config option unset or set to false--prevents | |
249 | unannotated tags to be pushed. | |
250 | ||
251 | [[post-receive]] | |
252 | post-receive | |
253 | ~~~~~~~~~~~~ | |
254 | ||
255 | This hook is invoked by 'git-receive-pack' on the remote repository, | |
256 | which happens when a 'git push' is done on a local repository. | |
257 | It executes on the remote repository once after all the refs have | |
258 | been updated. | |
259 | ||
260 | This hook executes once for the receive operation. It takes no | |
261 | arguments, but gets the same information as the | |
262 | <<pre-receive,'pre-receive'>> | |
263 | hook does on its standard input. | |
264 | ||
265 | This hook does not affect the outcome of 'git-receive-pack', as it | |
266 | is called after the real work is done. | |
267 | ||
268 | This supersedes the <<post-update,'post-update'>> hook in that it gets | |
269 | both old and new values of all the refs in addition to their | |
270 | names. | |
271 | ||
272 | Both standard output and standard error output are forwarded to | |
273 | 'git send-pack' on the other end, so you can simply `echo` messages | |
274 | for the user. | |
275 | ||
276 | The default 'post-receive' hook is empty, but there is | |
277 | a sample script `post-receive-email` provided in the `contrib/hooks` | |
278 | directory in Git distribution, which implements sending commit | |
279 | emails. | |
280 | ||
281 | [[post-update]] | |
282 | post-update | |
283 | ~~~~~~~~~~~ | |
284 | ||
285 | This hook is invoked by 'git-receive-pack' on the remote repository, | |
286 | which happens when a 'git push' is done on a local repository. | |
287 | It executes on the remote repository once after all the refs have | |
288 | been updated. | |
289 | ||
290 | It takes a variable number of parameters, each of which is the | |
291 | name of ref that was actually updated. | |
292 | ||
293 | This hook is meant primarily for notification, and cannot affect | |
294 | the outcome of 'git-receive-pack'. | |
295 | ||
296 | The 'post-update' hook can tell what are the heads that were pushed, | |
297 | but it does not know what their original and updated values are, | |
298 | so it is a poor place to do log old..new. The | |
299 | <<post-receive,'post-receive'>> hook does get both original and | |
300 | updated values of the refs. You might consider it instead if you need | |
301 | them. | |
302 | ||
303 | When enabled, the default 'post-update' hook runs | |
304 | 'git update-server-info' to keep the information used by dumb | |
305 | transports (e.g., HTTP) up-to-date. If you are publishing | |
306 | a Git repository that is accessible via HTTP, you should | |
307 | probably enable this hook. | |
308 | ||
309 | Both standard output and standard error output are forwarded to | |
310 | 'git send-pack' on the other end, so you can simply `echo` messages | |
311 | for the user. | |
312 | ||
313 | pre-auto-gc | |
314 | ~~~~~~~~~~~ | |
315 | ||
316 | This hook is invoked by 'git gc --auto'. It takes no parameter, and | |
317 | exiting with non-zero status from this script causes the 'git gc --auto' | |
318 | to abort. | |
319 | ||
320 | post-rewrite | |
321 | ~~~~~~~~~~~~ | |
322 | ||
323 | This hook is invoked by commands that rewrite commits (`git commit | |
324 | --amend`, 'git-rebase'; currently 'git-filter-branch' does 'not' call | |
325 | it!). Its first argument denotes the command it was invoked by: | |
326 | currently one of `amend` or `rebase`. Further command-dependent | |
327 | arguments may be passed in the future. | |
328 | ||
329 | The hook receives a list of the rewritten commits on stdin, in the | |
330 | format | |
331 | ||
332 | <old-sha1> SP <new-sha1> [ SP <extra-info> ] LF | |
333 | ||
334 | The 'extra-info' is again command-dependent. If it is empty, the | |
335 | preceding SP is also omitted. Currently, no commands pass any | |
336 | 'extra-info'. | |
337 | ||
338 | The hook always runs after the automatic note copying (see | |
339 | "notes.rewrite.<command>" in linkgit:git-config.txt) has happened, and | |
340 | thus has access to these notes. | |
341 | ||
342 | The following command-specific comments apply: | |
343 | ||
344 | rebase:: | |
345 | For the 'squash' and 'fixup' operation, all commits that were | |
346 | squashed are listed as being rewritten to the squashed commit. | |
347 | This means that there will be several lines sharing the same | |
348 | 'new-sha1'. | |
349 | + | |
350 | The commits are guaranteed to be listed in the order that they were | |
351 | processed by rebase. | |
352 | ||
353 | ||
354 | GIT | |
355 | --- | |
356 | Part of the linkgit:git[1] suite |