openstack/deb-python-pygit2
Code Issues Proposed changes

Extend comment of Remote.push by note about push_update_reference.

Browse Source 
As happened in support request https://github.com/libgit2/libgit2/issues/3963 it can be easily overseen,
that push returns True, when the remote has installed a hook that denies the commits.
This commit is contained in:
Robert Hölzl 2016-10-23 23:55:53 +02:00
parent 825f3e45bd
commit ee28de65a0
1 changed files with 6 additions and 0 deletions

6
pygit2/remote.py

@ -413,6 +413,12 @@ class Remote(object):
"""Push the given refspec to the remote. Raises ``GitError`` on """Push the given refspec to the remote. Raises ``GitError`` on
protocol error or unpack failure. protocol error or unpack failure.
When the remote has a githook installed, that denies the reference
this function will return successfully. Thus it is stronly recommended
to install a callback, that implements
:py:meth:`RemoteCallbacks.push_update_reference` and check the passed
parameters for successfull operations.
:param [str] specs: push refspecs to use :param [str] specs: push refspecs to use
""" """
push_opts = ffi.new('git_push_options *') push_opts = ffi.new('git_push_options *')