From 8a80a3607c38b72e056f604265f3591b7073e293 Mon Sep 17 00:00:00 2001 From: Eric Engestrom Date: Fri, 8 Sep 2023 10:28:59 +0100 Subject: [PATCH] docs: document the merging process and what is allowed or not Part-of: --- docs/ci/index.rst | 3 +++ docs/submittingpatches.rst | 28 ++++++++++++++++++++++++++++ 2 files changed, 31 insertions(+) diff --git a/docs/ci/index.rst b/docs/ci/index.rst index 65ce76add88..55115d3e58a 100644 --- a/docs/ci/index.rst +++ b/docs/ci/index.rst @@ -73,6 +73,9 @@ After farm restore functionality can be enabled by pushing a new merge request, git mv .ci-farms{-disabled,}/$farm_name +.. warning:: + Pushing (``git push``) directly to ``main`` is forbidden; this change must + be sent as a :ref:`Merge Request `. Application traces replay ------------------------- diff --git a/docs/submittingpatches.rst b/docs/submittingpatches.rst index 4fe6dd4e411..31f267a187d 100644 --- a/docs/submittingpatches.rst +++ b/docs/submittingpatches.rst @@ -270,6 +270,34 @@ project. The submitter is expected to evaluate whether they have an appropriate amount of review feedback from people who also understand the code before merging their patches. +.. _merging: + +Merging merge requests +---------------------- + +Once a merge request has been appropriately reviewed, its author can decide to +merge it. + +.. warning:: + Pushing (``git push``) directly to ``main`` is forbidden. This bypasses all + the CI checks and is likely to cause issues for everyone else. + +.. warning:: + Do not use the "Merge"/"Merge when pipeline succeeds"/"Set to auto-merge" + buttons. + +We use a `custom script `__ to manage +this, triggered by **assigning the MR** to the pseudo-user `@marge-bot +`__. + +Authors who do not have ``Developer`` access (or above) should ask on the +merge request for someone else to do it for them, or reach on `other channels +`__ if the MR reviewers don't have access themselves. + +Do not merge someone else's MR unless you are sure they don't have a new +version that they are testing locally for instance. +**When in doubt, ask**, for instance by leaving a comment on that MR. + Nominating a commit for a stable branch ---------------------------------------