diff options
author | Craig Scott <craig.scott@crascit.com> | 2019-11-11 12:28:13 (GMT) |
---|---|---|
committer | Kitware Robot <kwrobot@kitware.com> | 2019-11-11 12:28:24 (GMT) |
commit | e3aeae7ee80bfba17568a529f756eb23ef8269a1 (patch) | |
tree | 72852d62e6c7fca1bcfa3061928824b8e833ef12 /Help/dev/maint.rst | |
parent | eb306700d536849c4125d4a9b84e0bd40b4f2844 (diff) | |
parent | 75a5d1d4b17634e8ff3df6cdd3fce083aa23495c (diff) | |
download | CMake-e3aeae7ee80bfba17568a529f756eb23ef8269a1.zip CMake-e3aeae7ee80bfba17568a529f756eb23ef8269a1.tar.gz CMake-e3aeae7ee80bfba17568a529f756eb23ef8269a1.tar.bz2 |
Merge topic 'doc-backport'
75a5d1d4b1 Help/dev: Document "Backport:" footer for MR descriptions
12fd957ce3 Help/dev: Add 'external-discussion' to the main workflow status list
Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !4004
Diffstat (limited to 'Help/dev/maint.rst')
-rw-r--r-- | Help/dev/maint.rst | 18 |
1 files changed, 15 insertions, 3 deletions
diff --git a/Help/dev/maint.rst b/Help/dev/maint.rst index 44e2273..a1c1a6f 100644 --- a/Help/dev/maint.rst +++ b/Help/dev/maint.rst @@ -14,6 +14,11 @@ Review a Merge Request The `CMake Review Process`_ requires a maintainer to issue the ``Do: merge`` command to integrate a merge request. Please check at least the following: +* If the MR source branch (or part of it) should be backported + to the ``release`` branch (and is already based on a commit + contained in the ``release`` branch), add a ``Backport: release`` or + ``Backport: release:<commit-ish>`` trailing line to the MR description. + * If the MR source branch is not named well for the change it makes (e.g. it is just ``master`` or the patch changed during review), add a ``Topic-rename: <topic>`` trailing line to the MR description @@ -38,9 +43,10 @@ command to integrate a merge request. Please check at least the following: of various nightly builders.) * Ensure that the MR targets the ``master`` branch. A MR intended for - the ``release`` branch should be based on ``release`` but still merged - to ``master`` first (via ``Do: merge``). A maintainer may then merge - the MR topic to ``release`` manually. + the ``release`` branch should be based on ``release`` but still target + ``master``. Use the above-mentioned ``Backport: release`` line to tell + ``Do: merge`` to merge to both. If a MR is merged without the backport + line, a maintainer may still merge the MR topic to ``release`` manually. Maintain Current Release ======================== @@ -51,6 +57,12 @@ 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 an open MR to the ``release`` branch, edit its description to +use the ``Backport: release`` line mentioned above and then ``Do: merge`` +normally. To update the ``release`` branch manually (e.g. to merge a +``$topic`` branch that was merged without the backport line), use the +following procedure. + 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 |