Skip to content

Commit

Permalink
docs: Document changes to submit-backport
Browse files Browse the repository at this point in the history
Co-authored-by: Quentin Monnet <quentin@isovalent.com>
Signed-off-by: Sebastian Wicki <sebastian@isovalent.com>
  • Loading branch information
gandro and qmonnet committed Feb 17, 2021
1 parent 02320e3 commit 9d7b64c
Showing 1 changed file with 17 additions and 3 deletions.
20 changes: 17 additions & 3 deletions Documentation/contributing/release/backports.rst
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ One-time Setup
+--------------------------------------------------------------+-----------+---------------------------------------------------------+
| `PyGithub <https://pypi.org/project/PyGithub/>`_ | No | ``pip3 install PyGithub`` |
+--------------------------------------------------------------+-----------+---------------------------------------------------------+
| `Github hub CLI <https://github.com/github/hub>`_ | No | N/A (OS-specific) |
| `Github hub CLI (>= 2.8.3) <https://github.com/github/hub>`_ | No | N/A (OS-specific) |
+--------------------------------------------------------------+-----------+---------------------------------------------------------+

Verify your machine is correctly configured by running
Expand Down Expand Up @@ -184,14 +184,28 @@ the labels for the PRs that are backported, based on the
$ GITHUB_TOKEN=xxx contrib/backporting/submit-backport
The script takes up to three positional arguments:

.. code-block:: bash
usage: submit-backport [branch version] [pr-summary] [your remote]
- The first parameter is the version of the branch against which the PR should
be done, and defaults to the version passed to ``start-backport``.
- The second one is the name of the file containing the text summary to use for
the PR, and defaults to the file created by ``start-backport``.
- The third one is the name of the git remote of your (forked) repository to
which your changes will be pushed. It defaults to the git remote
which matches ``github.com/<your github username>/cilium``.

Via GitHub Web Interface
^^^^^^^^^^^^^^^^^^^^^^^^

#. Push your backports branch to cilium repo.
#. Push your backports branch to your fork of the Cilium repo.

.. code-block:: bash
$ git push -u origin HEAD
$ git push -u <remote_for_your_fork> HEAD
#. Create a new PR from your branch towards the feature branch you are
backporting to. Note that by default Github creates PRs against the
Expand Down

0 comments on commit 9d7b64c

Please sign in to comment.