Allow a user to pass information along a push to the pre/post-receive hook
on the remote.
When using a remote that is more than just a plain Git host (e.g. Gerrit,
Git{hub/lab}, etc) this may become more obvious: The (server backend specific)
push options can instruct the server to:
* open a pull request
* send out emails asking for review
* (un)trigger continuous integration
* set priority for continuous integration (i.e. bots pushing may ask to be
treated with lower priority compared to humans)
* ...
Most of these actions can be done on the client side as well,
but in these remote-centric workflows it is easier to do that on the remote,
which is why we need to transport the information there.
More concrete examples:
* When you want a change in Gerrit to be submitted to refs/heads/master, you
push instead to a magic branch refs/for/master and Gerrit will create a change
for you (similar to a pull request). Instead we could imagine that you push
to a magical refs/heads/master with a push option "create-change".
* When pushing to Gerrit you can already attach some of this information by
adding a '%' followed by the parameter to the ref, i.e. when interacting with
Gerrit it is possible to do things like[1]:
git push origin
HEAD:refs/for/master%draft%topic=example%[email protected]
This is not appealing to our users as it looks like hacks upon hacks to make
it work. It would read better if it was spelled as:
git push origin HEAD:refs/for/master \
--push-option draft \
--push-option topic=example \
--push-option [email protected]
(with a short form that is even easier to type,
but this is is more intuitive already)
This is a patch series to Git core, which is developed at the same time
as a change is proposed to JGit by Dan Wang, see [2].
This code is also available at [3].
Thanks,
Stefan
[1] Not all Gerrit '%' options are documented, so here is a link to source code
instead :(
https://gerrit.googlesource.com/gerrit/+/refs/heads/master/gerrit-server/src/main/java/com/google/gerrit/server/git/ReceiveCommits.java#1141
[2] https://git.eclipse.org/r/#/c/74570/
[3] https://github.com/stefanbeller/git/tree/pushoptions
Stefan Beller (4):
push options: {pre,post}-receive hook learns about push options
receive-pack: implement advertising and receiving push options
push: accept push options
add a test for push options
Documentation/config.txt | 7 +-
Documentation/git-push.txt | 8 ++-
Documentation/githooks.txt | 4 ++
Documentation/technical/pack-protocol.txt | 10 +--
Documentation/technical/protocol-capabilities.txt | 8 +++
builtin/push.c | 16 ++++-
builtin/receive-pack.c | 85 +++++++++++++++++++----
send-pack.c | 29 ++++++++
send-pack.h | 3 +
t/t5544-push-options.sh | 85 +++++++++++++++++++++++
transport.c | 2 +
transport.h | 7 ++
12 files changed, 242 insertions(+), 22 deletions(-)
create mode 100755 t/t5544-push-options.sh
--
2.9.0.141.gdd65b60
--
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to [email protected]
More majordomo info at http://vger.kernel.org/majordomo-info.html
