openstack/openstack-manuals
Code Issues Proposed changes

[contributor] Remove obsolete workflows

Browse Source 
We do not branch openstack-manuals anymore and have no content to
backport anymore, so remove the cherry-pick and backport instructions as
they are obsolete.

Changes for older branches will not come as backports anymore.

Change-Id: Ia6e80564e696e30071834381b51e4328a66e0683
This commit is contained in:
Andreas Jaeger 2017-08-30 21:35:53 +02:00
parent 5625171107
commit db9ddfd399
3 changed files with 0 additions and 96 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/contributor-guide/source/additional-git-workflow.rst
View File

@ -11,6 +11,4 @@ while contributing to OpenStack documentation.
.. toctree::
:maxdepth: 2
additional-git-workflow/cherry-pick.rst
additional-git-workflow/backport.rst
additional-git-workflow/rebase.rst

28
doc/contributor-guide/source/additional-git-workflow/backport.rst
View File

@ -1,28 +0,0 @@
.. _backport:
Backport a change
~~~~~~~~~~~~~~~~~
When committing to the master branch, add the ``backport`` line to your
commit message for potential backport patches (Installation Tutorials and
Guides, Configuration Reference, Networking Guide, and common directory).
For example:
* To backport to a single branch:
.. code-block:: console
backport: mitaka
* To backport to multiple branches:
.. code-block:: console
backport: mitaka liberty
* If no backporting is needed, do not add the ``backport`` line,
or explicitly add:
.. code-block:: console
backport: none

66
doc/contributor-guide/source/additional-git-workflow/cherry-pick.rst
View File

@ -1,66 +0,0 @@
.. _cherry-pick:
Cherry pick a change
~~~~~~~~~~~~~~~~~~~~
If a docfix was submitted to the master openstack-manuals branch and you want
to reflect this change, for example, in the Kilo documentation, which is
closed, you can cherry pick the change and submit it.
Use the :guilabel:`Cherry Pick To` button in Gerrit Web UI from the original
master review page. If the :guilabel:`Cherry Pick To` button does not work, it
means that there are conflicts and you need to cherry pick the patch manually.
For example, you want to cherry pick bug/1506693 (review 235734) into Kilo:
#. Wait for the change to be merged into the master branch.
#. Make sure your repository is up to date:
.. code-block:: console
$ git fetch origin
#. Create a topic branch by branching from Kilo:
.. code-block:: console
$ git checkout -b kilo-bug/1506693 remotes/origin/stable/kilo
#. On the Gerrit web page that contains the review you want to backport,
click :guilabel:`cherry-pick`. It is located under :guilabel:`Patch Set N`,
in the :guilabel:`Download` row.
#. Copy the text, then paste it into your terminal. For example, for review
235734, it looks like this:
.. code-block:: console
$ git fetch https://review.openstack.org/openstack/openstack-manuals \
refs/changes/34/235734/1 && git cherry-pick -x FETCH_HEAD
.. note::
Use the -x option with the :command:`cherry-pick` command to preserve
git history metadata in the cherry pick commit message.
#. Resolve conflicts if any, then run:
.. code-block:: console
$ git cherry-pick --continue
#. Run :command:`tox`, and then commit your change:
.. code-block:: console
$ git commit --amend
#. Make sure you retain the original Change-Id from the previous commit
message. This facilitates tracking of backports into all affected branches.
You may add "Cherry-pick from review.openstack.org/URL" to the commit
message to make it easier for reviewers. Push the commit for review:
.. code-block:: console
$ git review