git.oblomov.eu Git - git/blob - 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.
  60
  61 This hook is called before any refname is updated and before any
  62 fast-forward checks are performed.
  63
  64 If the pre-receive hook exits with a non-zero exit status no updates
  65 will be performed, and the update, post-receive and post-update
  66 hooks will not be invoked either.  This can be useful to quickly
  67 bail out if the update is not to be supported.
  68
  69 update Hook
  70 -----------
  71 Before each ref is updated, if $GIT_DIR/hooks/update file exists
  72 and is executable, it is invoked once per ref, with three parameters:
  73
  74        $GIT_DIR/hooks/update refname sha1-old sha1-new
  75
  76 The refname parameter is relative to $GIT_DIR; e.g. for the master
  77 head this is "refs/heads/master".  The two sha1 arguments are
  78 the object names for the refname before and after the update.
  79 Note that the hook is called before the refname is updated,
  80 so either sha1-old is 0\{40} (meaning there is no such ref yet),
  81 or it should match what is recorded in refname.
  82
  83 The hook should exit with non-zero status if it wants to disallow
  84 updating the named ref.  Otherwise it should exit with zero.
  85
  86 Successful execution (a zero exit status) of this hook does not
  87 ensure the ref will actually be updated, it is only a prerequisite.
  88 As such it is not a good idea to send notices (e.g. email) from
  89 this hook.  Consider using the post-receive hook instead.
  90
  91 post-receive Hook
  92 -----------------
  93 After all refs were updated (or attempted to be updated), if any
  94 ref update was successful, and if $GIT_DIR/hooks/post-receive
  95 file exists and is executable, it will be invoked once with no
  96 parameters.  The standard input of the hook will be one line
  97 for each successfully updated ref:
  98
  99        sha1-old SP sha1-new SP refname LF
 100
 101 The refname value is relative to $GIT_DIR; e.g. for the master
 102 head this is "refs/heads/master".  The two sha1 values before
 103 each refname are the object names for the refname before and after
 104 the update.  Refs that were created will have sha1-old equal to
 105 0\{40}, while refs that were deleted will have sha1-new equal to
 106 0\{40}, otherwise sha1-old and sha1-new should be valid objects in
 107 the repository.
 108
 109 The `GIT_PUSH_CERT` environment variable can be inspected, just as
 110 in `pre-receive` hook, after accepting a signed push.
 111
 112 Using this hook, it is easy to generate mails describing the updates
 113 to the repository.  This example script sends one mail message per
 114 ref listing the commits pushed to the repository, and logs the push
 115 certificates of signed pushes to a logger
 116 service:
 117
 118         #!/bin/sh
 119         # mail out commit update information.
 120         while read oval nval ref
 121         do
 122                 if expr "$oval" : '0*$' >/dev/null
 123                 then
 124                         echo "Created a new ref, with the following commits:"
 125                         git rev-list --pretty "$nval"
 126                 else
 127                         echo "New commits:"
 128                         git rev-list --pretty "$nval" "^$oval"
 129                 fi |
 130                 mail -s "Changes to ref $ref" commit-list@mydomain
 131         done
 132         # log signed push certificate, if any
 133         if test -n "${GIT_PUSH_CERT-}"
 134         then
 135                 (
 136                         git cat-file blob ${GIT_PUSH_CERT}
 137                 ) | mail -s "push certificate" push-log@mydomain
 138         fi
 139         exit 0
 140
 141 The exit code from this hook invocation is ignored, however a
 142 non-zero exit code will generate an error message.
 143
 144 Note that it is possible for refname to not have sha1-new when this
 145 hook runs.  This can easily occur if another user modifies the ref
 146 after it was updated by 'git-receive-pack', but before the hook was able
 147 to evaluate it.  It is recommended that hooks rely on sha1-new
 148 rather than the current value of refname.
 149
 150 post-update Hook
 151 ----------------
 152 After all other processing, if at least one ref was updated, and
 153 if $GIT_DIR/hooks/post-update file exists and is executable, then
 154 post-update will be called with the list of refs that have been updated.
 155 This can be used to implement any repository wide cleanup tasks.
 156
 157 The exit code from this hook invocation is ignored; the only thing
 158 left for 'git-receive-pack' to do at that point is to exit itself
 159 anyway.
 160
 161 This hook can be used, for example, to run `git update-server-info`
 162 if the repository is packed and is served via a dumb transport.
 163
 164         #!/bin/sh
 165         exec git update-server-info
 166
 167
 168 SEE ALSO
 169 --------
 170 linkgit:git-send-pack[1], linkgit:gitnamespaces[7]
 171
 172 GIT
 173 ---
 174 Part of the linkgit:git[1] suite