summaryrefslogtreecommitdiffstats
path: root/Help/dev
diff options
context:
space:
mode:
authorCraig Scott <craig.scott@crascit.com>2018-07-25 12:54:37 (GMT)
committerCraig Scott <craig.scott@crascit.com>2018-07-25 21:41:19 (GMT)
commit6161a64a529d8c7a5ba4e0d8a777605a0558f2ad (patch)
tree9e326c28a9334262ad204162ba5bfa1d8844a844 /Help/dev
parent3ab6f056dc8765c98e62a04a16fa24f23f201b7a (diff)
downloadCMake-6161a64a529d8c7a5ba4e0d8a777605a0558f2ad.zip
CMake-6161a64a529d8c7a5ba4e0d8a777605a0558f2ad.tar.gz
CMake-6161a64a529d8c7a5ba4e0d8a777605a0558f2ad.tar.bz2
maint: Add further details about merging topics to release branch
The Maintain Current Release instructions previously assumed that the topic branch had been merged to master. Add text to make this explicit in the instructions as an initial verification step. The previous instructions also made no mention of the commit message for the merge to the release branch. This needs to include a footer that mentions the merge request number for tracking purposes.
Diffstat (limited to 'Help/dev')
-rw-r--r--Help/dev/maint.rst9
1 files changed, 6 insertions, 3 deletions
diff --git a/Help/dev/maint.rst b/Help/dev/maint.rst
index ec76479..a8942cd 100644
--- a/Help/dev/maint.rst
+++ b/Help/dev/maint.rst
@@ -51,15 +51,18 @@ using a local branch named ``release-$ver``, where ``$ver`` is the version
number of the current release in the form ``$major.$minor``. It is always
merged into ``master`` before publishing.
-To merge some ``$topic`` branch into ``release``, first create the local
-branch:
+Before merging a ``$topic`` branch into ``release``, verify that the
+``$topic`` branch has already been merged to ``master`` via the usual
+``Do: merge`` process. Then, to merge the ``$topic`` branch into
+``release``, start by creating the local branch:
.. code-block:: shell
git fetch origin
git checkout -b release-$ver origin/release
-Merge the ``$topic`` branch into the local ``release-$ver`` branch:
+Merge the ``$topic`` branch into the local ``release-$ver`` branch, making
+sure to include a ``Merge-request: !xxxx`` footer in the commit message:
.. code-block:: shell