Docs: Add auto-merge information 65/68165/3
authorJessica Wagantall <jwagantall@linuxfoundation.org>
Tue, 29 Jun 2021 00:13:28 +0000 (17:13 -0700)
committerJessica Wagantall <jwagantall@linuxfoundation.org>
Tue, 29 Jun 2021 17:52:12 +0000 (10:52 -0700)
Add information on how auto-merge works
for committer management and how to enable it.

Issue: RELENG-3774
Signed-off-by: Jessica Wagantall <jwagantall@linuxfoundation.org>
Change-Id: Ib55a7ab7ae4570aa5b1aa852ff417f115feafd2d

docs/committer-management.rst

index 3020be9..24c4605 100644 (file)
@@ -251,3 +251,43 @@ Example INFO file
             - type: ''
               name: ''
               link: ''
+
+INFO.yaml auto-merge job
+========================
+
+The auto-merge job triggers after an INFO.yaml verify run for committer changes for
+an already exisiting repository.
+
+The job checks if the change verified belongs to a project where either TSC or TOC
+members approved automatically merging changes after the INFO verify job votes +1 Verified.
+
+Auto-merge skips changes for new project creation as it detects a new INFO.yaml file.
+In such case, a RELENG engineer needs to review the change.
+
+How to enable auto-merge
+------------------------
+
+#. Get TSC or TOC approval to enable auto-merge in your project
+
+#. Clone the LF ci-management repo
+
+   .. code-block:: bash
+
+      git clone "https://gerrit.linuxfoundation.org/infra/ci-management"
+
+#. Edit info-auto-merge script in jjb/ci-management/info-auto-merge.sh
+
+   .. code-block:: bash
+
+      if [[ $gerrit_name == "onap" || $gerrit_name == "o-ran-sc" ]]; then
+
+   .. note::
+
+      Add your project to the IF block in a new OR statement.
+      This IF block allows approved projects to auto-merge changes and skips if the project
+      is not listed.
+
+#. Push your change and wait for reviews and approval
+
+After merging your change, the account "lf-auto-merge" will +2 Code Review and Submit INFO.yaml file
+changes approved by info-master-verify.