This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "CMake".
The branch, master has been updated
via e3aeae7ee80bfba17568a529f756eb23ef8269a1 (commit)
via 75a5d1d4b17634e8ff3df6cdd3fce083aa23495c (commit)
via 12fd957ce3dc1d66a9161594679558fd8a73c284 (commit)
from eb306700d536849c4125d4a9b84e0bd40b4f2844 (commit)
Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.
- Log -----------------------------------------------------------------
https://cmake.org/gitweb?p=cmake.git;a=commitdiff;h=e3aeae7ee80bfba17568a529f756eb23ef8269a1
commit e3aeae7ee80bfba17568a529f756eb23ef8269a1
Merge: eb306700d5 75a5d1d4b1
Author: Craig Scott <craig.sc...@crascit.com>
AuthorDate: Mon Nov 11 12:28:13 2019 +0000
Commit: Kitware Robot <kwro...@kitware.com>
CommitDate: Mon Nov 11 07:28:24 2019 -0500
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 <kwro...@kitware.com>
Merge-request: !4004
https://cmake.org/gitweb?p=cmake.git;a=commitdiff;h=75a5d1d4b17634e8ff3df6cdd3fce083aa23495c
commit 75a5d1d4b17634e8ff3df6cdd3fce083aa23495c
Author: Brad King <brad.k...@kitware.com>
AuthorDate: Wed Nov 6 12:02:05 2019 -0500
Commit: Craig Scott <craig.sc...@crascit.com>
CommitDate: Mon Nov 11 23:24:29 2019 +1100
Help/dev: Document "Backport:" footer for MR descriptions
diff --git a/Help/dev/maint.rst b/Help/dev/maint.rst
index 44e2273477..a1c1a6fada 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
diff --git a/Help/dev/review.rst b/Help/dev/review.rst
index 36b9789ea0..8ec41d29c6 100644
--- a/Help/dev/review.rst
+++ b/Help/dev/review.rst
@@ -433,6 +433,21 @@ Additionally, ``Do: merge`` extracts configuration from
trailing lines
in the MR description (the following have no effect if used in a MR
comment instead):
+* ``Backport: release[:<commit-ish>]``: merge the topic branch into
+ the ``release`` branch to backport the change. This is allowed
+ only if the topic branch is based on a commit in ``release`` already.
+ If only part of the topic branch should be backported, specify it as
+ ``:<commit-ish>``. The ``<commit-ish>`` may use `git rev-parse`_
+ syntax to reference commits relative to the topic ``HEAD``.
+ See additional `backport instructions`_ for details.
+ For example:
+
+ ``Backport: release``
+ Merge the topic branch head into both ``release`` and ``master``.
+ ``Backport: release:HEAD~1^2``
+ Merge the topic branch head's parent's second parent commit into
+ the ``release`` branch. Merge the topic branch head to ``master``.
+
* ``Topic-rename: <topic>``: substitute ``<topic>`` for the name of
the MR topic branch in the constructed merge commit message.
It is also used in merge commits constructed by ``Do: stage``.
@@ -440,6 +455,8 @@ comment instead):
rename set in the MR description.
.. _`CMake GitLab Project Masters`:
https://gitlab.kitware.com/cmake/cmake/settings/members
+.. _`backport instructions`:
https://gitlab.kitware.com/utils/git-workflow/wikis/Backport-topics
+.. _`git rev-parse`: https://git-scm.com/docs/git-rev-parse
Close
-----
https://cmake.org/gitweb?p=cmake.git;a=commitdiff;h=12fd957ce3dc1d66a9161594679558fd8a73c284
commit 12fd957ce3dc1d66a9161594679558fd8a73c284
Author: Brad King <brad.k...@kitware.com>
AuthorDate: Wed Nov 6 12:00:53 2019 -0500
Commit: Brad King <brad.k...@kitware.com>
CommitDate: Wed Nov 6 12:02:23 2019 -0500
Help/dev: Add 'external-discussion' to the main workflow status list
This was accidentally left out of commit 49f5b6f7bf (Help: Document the
expire and external discussion resolve states, 2019-05-26,
v3.15.0-rc1~35^2).
diff --git a/Help/dev/review.rst b/Help/dev/review.rst
index cbde6feead..36b9789ea0 100644
--- a/Help/dev/review.rst
+++ b/Help/dev/review.rst
@@ -53,6 +53,10 @@ in GitLab to track the state of a MR:
to a period of inactivity. See the `Expire`_ step. Use this label
after closing a MR for this reason.
+* ``workflow:external-discussion`` indicates that the MR has been closed
+ pending discussion elsewhere. See the `External Discussion`_ step.
+ Use this label after closing a MR for this reason.
+
The workflow status labels are intended to be mutually exclusive,
so please remove any existing workflow label when adding one.
-----------------------------------------------------------------------
Summary of changes:
Help/dev/maint.rst | 18 +++++++++++++++---
Help/dev/review.rst | 21 +++++++++++++++++++++
2 files changed, 36 insertions(+), 3 deletions(-)
hooks/post-receive
--
CMake
_______________________________________________
Cmake-commits mailing list
Cmake-commits@cmake.org
https://cmake.org/mailman/listinfo/cmake-commits
