[PATCH] D97389: added section on CI system

[Christian Kühnel via Phabricator via llvm-commits]

kuhnel updated this revision to Diff 336336.
kuhnel marked 3 inline comments as done.
kuhnel added a comment.

addressed Galinas comments


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D97389/new/

https://reviews.llvm.org/D97389

Files:
  llvm/docs/DeveloperPolicy.rst
  llvm/docs/buildbot_worker_contact.png


Index: llvm/docs/DeveloperPolicy.rst
===================================================================
--- llvm/docs/DeveloperPolicy.rst
+++ llvm/docs/DeveloperPolicy.rst
@@ -560,6 +560,57 @@
 
 .. _new-llvm-components:
 
+Working with the CI system
+--------------------------
+
+The main continuous integration (CI) tool for the LLVM project are the 
+`BuildBots <https://lab.llvm.org/buildbot/>`_. These use different *builders* to
+cover a wide variety of sub-projects and configurations. The builds are executed
+on different *workers*. Builders and workers are configured and provided by
+community members.
+
+The BuildBots track the commits on the main branch and the release branches. 
+This means that patches are built and tested after they are merged to the these
+branches (aka. post-merge testing). This also means it's okay to break the build
+occasionally, as it's unreasonable to expect contributors to build and test
+their patch with every possible configuration. 
+
+*If your commit broke the build:*
+
+* Fix the build as soon as possible as this might block other contributors or
+  downstream users.
+* If you need more time analyze and fix the bug, please revert your change to
+  unblock others.
+
+*If someone else broke the build and this blocks your work*
+
+* Comment on the code review in `Phabricator <https://reviews.llvm.org/>`_ 
+  (if available) or email the author, explain the problem and how this impacts
+  you. Add a link to the broken build and the error message so folks can
+  understand the problem.
+* Revert the commit if this blocks your work.
+
+*If a build/worker is permanently broken*
+
+* 1st step: contact the owner of the worker. You can find the name and contact
+  information for the *Admin* of worker on the page of the build in the 
+  *Worker* tab:
+
+  .. image:: buildbot_worker_contact.png
+
+* 2nd step: If the owner does not respond or fix the worker, please escalate 
+  to Galina Kostanova, the maintainer of the BuildBot master.
+* 3rd step: If Galina could not help you, please escalate to the 
+  Infrastructure Working Group `mailto:iwg at llvm.org`.
+
+There are other CI and testing systems provided by the community, however it is
+optional to monitor these:
+
+* `Green Dragon <http://green.lab.llvm.org/green/>`_
+* `LNT <http://lnt.llvm.org/>`_ performance tracking system
+* `gn bot <http://45.33.8.238/>`_
+* `pre-merge testing <https://github.com/google/llvm-premerge-checks/>`_
+
 Introducing New Components into LLVM
 ====================================
 


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D97389.336336.patch
Type: text/x-patch
Size: 2538 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20210409/71a6d9d5/attachment.bin>