Documentation/git-receive-pack.txt

   1 git-receive-pack(1)
   2 ===================
   3
   4 NAME
   5 ----
   6 git-receive-pack - Receive what is pushed into the repository
   7
   8
   9 SYNOPSIS
  10 --------
  11 [verse]
  12 'git-receive-pack' <directory>
  13
  14 DESCRIPTION
  15 -----------
  16 Invoked by 'git send-pack' and updates the repository with the
  17 information fed from the remote end.
  18
  19 This command is usually not invoked directly by the end user.
  20 The UI for the protocol is on the 'git send-pack' side, and the
  21 program pair is meant to be used to push updates to remote
  22 repository.  For pull operations, see linkgit:git-fetch-pack[1].
  23
  24 The command allows for creation and fast-forwarding of sha1 refs
  25 (heads/tags) on the remote end (strictly speaking, it is the
  26 local end 'git-receive-pack' runs, but to the user who is sitting at
  27 the send-pack end, it is updating the remote.  Confused?)
  28
  29 There are other real-world examples of using update and
  30 post-update hooks found in the Documentation/howto directory.
  31
  32 'git-receive-pack' honours the receive.denyNonFastForwards config
  33 option, which tells it if updates to a ref should be denied if they
  34 are not fast-forwards.
  35
  36 OPTIONS
  37 -------
  38 <directory>::
  39         The repository to sync into.
  40
  41 pre-receive Hook
  42 ----------------
  43 Before any ref is updated, if $GIT_DIR/hooks/pre-receive file exists
  44 and is executable, it will be invoked once with no parameters.  The
  45 standard input of the hook will be one line per ref to be updated:
  46
  47        sha1-old SP sha1-new SP refname LF
  48
  49 The refname value is relative to $GIT_DIR; e.g. for the master
  50 head this is "refs/heads/master".  The two sha1 values before
  51 each refname are the object names for the refname before and after
  52 the update.  Refs to be created will have sha1-old equal to 0\{40},
  53 while refs to be deleted will have sha1-new equal to 0\{40}, otherwise
  54 sha1-old and sha1-new should be valid objects in the repository.
  55
  56 When accepting a signed push (see linkgit:git-push[1]), the signed
  57 push certificate is stored in a blob and an environment variable
  58 `GIT_PUSH_CERT` can be consulted for its object name.  See the
  59 description of `post-receive` hook for an example.  In addition, the
  60 certificate is verified using GPG and the result is exported with
  61 the following environment variables:
  62
  63 `GIT_PUSH_CERT_SIGNER`::
  64         The name and the e-mail address of the owner of the key that
  65         signed the push certificate.
  66
  67 `GIT_PUSH_CERT_KEY`::
  68         The GPG key ID of the key that signed the push certificate.
  69
  70 `GIT_PUSH_CERT_STATUS`::
  71         The status of GPG verification of the push certificate,
  72         using the same mnemonic as used in `%G?` format of `git log`
  73         family of commands (see linkgit:git-log[1]).
  74
  75 `GIT_PUSH_CERT_NONCE`::
  76         The nonce string the process asked the signer to include
  77         in the push certificate.  If this does not match the value
  78         recorded on the "nonce" header in the push certificate, it
  79         may indicate that the certificate is a valid one that is
  80         being replayed from a separate "git push" session.
  81
  82 `GIT_PUSH_CERT_NONCE_STATUS`::
  83 `UNSOLICITED`;;
  84         "git push --signed" sent a nonce when we did not ask it to
  85         send one.
  86 `MISSING`;;
  87         "git push --signed" did not send any nonce header.
  88 `BAD`;;
  89         "git push --signed" sent a bogus nonce.
  90 `OK`;;
  91         "git push --signed" sent the nonce we asked it to send.
  92 `SLOP`;;
  93         "git push --signed" sent a nonce different from what we
  94         asked it to send now, but in a previous session.  See
  95         `GIT_PUSH_CERT_NONCE_SLOP` environment variable.
  96
  97 `GIT_PUSH_CERT_NONCE_SLOP`::
  98         "git push --signed" sent a nonce different from what we
  99         asked it to send now, but in a different session whose
 100         starting time is different by this many seconds from the
 101         current session.  Only meaningful when
 102         `GIT_PUSH_CERT_NONCE_STATUS` says `SLOP`.
 103         Also read about `receive.certNonceSlop` variable in
 104         linkgit:git-config[1].
 105
 106 This hook is called before any refname is updated and before any
 107 fast-forward checks are performed.
 108
 109 If the pre-receive hook exits with a non-zero exit status no updates
 110 will be performed, and the update, post-receive and post-update
 111 hooks will not be invoked either.  This can be useful to quickly
 112 bail out if the update is not to be supported.
 113
 114 update Hook
 115 -----------
 116 Before each ref is updated, if $GIT_DIR/hooks/update file exists
 117 and is executable, it is invoked once per ref, with three parameters:
 118
 119        $GIT_DIR/hooks/update refname sha1-old sha1-new
 120
 121 The refname parameter is relative to $GIT_DIR; e.g. for the master
 122 head this is "refs/heads/master".  The two sha1 arguments are
 123 the object names for the refname before and after the update.
 124 Note that the hook is called before the refname is updated,
 125 so either sha1-old is 0\{40} (meaning there is no such ref yet),
 126 or it should match what is recorded in refname.
 127
 128 The hook should exit with non-zero status if it wants to disallow
 129 updating the named ref.  Otherwise it should exit with zero.
 130
 131 Successful execution (a zero exit status) of this hook does not
 132 ensure the ref will actually be updated, it is only a prerequisite.
 133 As such it is not a good idea to send notices (e.g. email) from
 134 this hook.  Consider using the post-receive hook instead.
 135
 136 post-receive Hook
 137 -----------------
 138 After all refs were updated (or attempted to be updated), if any
 139 ref update was successful, and if $GIT_DIR/hooks/post-receive
 140 file exists and is executable, it will be invoked once with no
 141 parameters.  The standard input of the hook will be one line
 142 for each successfully updated ref:
 143
 144        sha1-old SP sha1-new SP refname LF
 145
 146 The refname value is relative to $GIT_DIR; e.g. for the master
 147 head this is "refs/heads/master".  The two sha1 values before
 148 each refname are the object names for the refname before and after
 149 the update.  Refs that were created will have sha1-old equal to
 150 0\{40}, while refs that were deleted will have sha1-new equal to
 151 0\{40}, otherwise sha1-old and sha1-new should be valid objects in
 152 the repository.
 153
 154 The `GIT_PUSH_CERT*` environment variables can be inspected, just as
 155 in `pre-receive` hook, after accepting a signed push.
 156
 157 Using this hook, it is easy to generate mails describing the updates
 158 to the repository.  This example script sends one mail message per
 159 ref listing the commits pushed to the repository, and logs the push
 160 certificates of signed pushes with good signatures to a logger
 161 service:
 162
 163         #!/bin/sh
 164         # mail out commit update information.
 165         while read oval nval ref
 166         do
 167                 if expr "$oval" : '0*$' >/dev/null
 168                 then
 169                         echo "Created a new ref, with the following commits:"
 170                         git rev-list --pretty "$nval"
 171                 else
 172                         echo "New commits:"
 173                         git rev-list --pretty "$nval" "^$oval"
 174                 fi |
 175                 mail -s "Changes to ref $ref" commit-list@mydomain
 176         done
 177         # log signed push certificate, if any
 178         if test -n "${GIT_PUSH_CERT-}" && test ${GIT_PUSH_CERT_STATUS} = G
 179         then
 180                 (
 181                         echo expected nonce is ${GIT_PUSH_NONCE}
 182                         git cat-file blob ${GIT_PUSH_CERT}
 183                 ) | mail -s "push certificate from $GIT_PUSH_CERT_SIGNER" push-log@mydomain
 184         fi
 185         exit 0
 186
 187 The exit code from this hook invocation is ignored, however a
 188 non-zero exit code will generate an error message.
 189
 190 Note that it is possible for refname to not have sha1-new when this
 191 hook runs.  This can easily occur if another user modifies the ref
 192 after it was updated by 'git-receive-pack', but before the hook was able
 193 to evaluate it.  It is recommended that hooks rely on sha1-new
 194 rather than the current value of refname.
 195
 196 post-update Hook
 197 ----------------
 198 After all other processing, if at least one ref was updated, and
 199 if $GIT_DIR/hooks/post-update file exists and is executable, then
 200 post-update will be called with the list of refs that have been updated.
 201 This can be used to implement any repository wide cleanup tasks.
 202
 203 The exit code from this hook invocation is ignored; the only thing
 204 left for 'git-receive-pack' to do at that point is to exit itself
 205 anyway.
 206
 207 This hook can be used, for example, to run `git update-server-info`
 208 if the repository is packed and is served via a dumb transport.
 209
 210         #!/bin/sh
 211         exec git update-server-info
 212
 213
 214 SEE ALSO
 215 --------
 216 linkgit:git-send-pack[1], linkgit:gitnamespaces[7]
 217
 218 GIT
 219 ---
 220 Part of the linkgit:git[1] suite