This is an archive of the discontinued LLVM Phabricator instance.

Differential D97389

added section on CI system
ClosedPublic

Authored by kuhnel on Feb 24 2021, 7:34 AM.

Details

Reviewers
reames
gkistanova
Commits
rG7f9717b922d4: added section on CI system
Summary

Add documentation for working with the CI systems.

This is based on the discussion in the Infrastructure Working Group:
https://github.com/ChristianKuehnel/iwg-workspace/issues/37

Diff Detail

Event Timeline

kuhnel requested review of this revision.Feb 24 2021, 7:34 AM
kuhnel created this revision.
Herald added a project: Restricted Project. · View Herald TranscriptFeb 24 2021, 7:34 AM
Herald added a subscriber: llvm-commits. · View Herald Transcript
kuhnel updated this revision to Diff 326093.Feb 24 2021, 7:48 AM

added missing information on worker tab

kuhnel added a reviewer: reames.Feb 24 2021, 7:48 AM
Harbormaster completed remote builds in B90614: Diff 326093.Feb 24 2021, 8:59 AM
kuhnel added a comment.Mar 2 2021, 1:56 AM

ping @reames

kuhnel updated this revision to Diff 331893.Mar 19 2021, 8:42 AM

added screenshot

kuhnel added a comment.Mar 19 2021, 8:43 AM

@reames I added a screenshot as you wanted. Please let me know if that addresses your usecase.

kuhnel added a reviewer: gkistanova.Mar 19 2021, 8:43 AM
reames accepted this revision.Mar 19 2021, 9:27 AM

LGTM

This revision is now accepted and ready to land.Mar 19 2021, 9:27 AM
Harbormaster completed remote builds in B94719: Diff 331893.Mar 19 2021, 11:01 AM
kuhnel added a comment.Apr 3 2021, 3:15 AM

@gkistanova are you OK with this documentation change?

gkistanova added a comment.Apr 7 2021, 12:02 PM

Thanks for updating the LLVM Developer Policy, Christian.
It looks good with a couple nit picks.

llvm/docs/DeveloperPolicy.rst
572

There is a set of builders with the name suffix "-release", for example https://lab.llvm.org/buildbot/#/builders/clang-with-thin-lto-ubuntu-release. These builders track the commits on the release branches to do the release testing.

610

LNT is a performance tracking system, not quite a CI.

fhahn added a subscriber: fhahn.Apr 7 2021, 12:22 PM
fhahn added inline comments.
llvm/docs/DeveloperPolicy.rst
609

I'm not sure about the official status of green dragon, but I think in practice breaking one of those is considered similar to breaking bots at https://lab.llvm.org/buildbot/ (most bots for various Apple platforms are on green dragon rather than https://lab.llvm.org/buildbot)

kuhnel updated this revision to Diff 336336.Apr 9 2021, 1:10 AM
kuhnel marked 3 inline comments as done.

addressed Galinas comments

llvm/docs/DeveloperPolicy.rst
609

I'm also not aware of any official policy around green dragons. So as I did not find any policy, I would assume they are optional as well...

tschuett added a subscriber: tschuett.Apr 9 2021, 1:16 AM

There is now an official revert policy:
https://reviews.llvm.org/D99305

kuhnel added a comment.Apr 9 2021, 1:37 AM

@tschuett, thx I missed that update, just added a link to that...

kuhnel updated this revision to Diff 336344.Apr 9 2021, 1:38 AM

added link to revert policy

Harbormaster completed remote builds in B97898: Diff 336336.Apr 9 2021, 2:35 AM
Harbormaster completed remote builds in B97903: Diff 336344.
azharudd added a subscriber: azharudd.Apr 9 2021, 10:16 AM
azharudd added inline comments.
llvm/docs/DeveloperPolicy.rst
566–567
572
606–612

I think it is best to just remove this part.

  • Issues reported by any CI system are to be fixed
  • LNT is not CI, whereas this section is talking about CI system
  • pre-merge testing is optional, covers only Phab reviews and already posts updates on the review
kuhnel marked 3 inline comments as done.Apr 21 2021, 12:36 AM
kuhnel added inline comments.
llvm/docs/DeveloperPolicy.rst
606–612

you're right, this does not really add value here.

kuhnel updated this revision to Diff 339128.Apr 21 2021, 12:37 AM
kuhnel marked an inline comment as done.

addressed azharudd's comments

This revision was landed with ongoing or failed builds.Apr 21 2021, 12:59 AM
Closed by commit rG7f9717b922d4: added section on CI system (authored by kuhnel). · Explain Why
This revision was automatically updated to reflect the committed changes.
kuhnel added a commit: rG7f9717b922d4: added section on CI system.
Harbormaster completed remote builds in B99906: Diff 339128.Apr 21 2021, 1:58 AM

Revision Contents

PathSize
llvm/
docs/
45 lines

Diff 326092

llvm/docs/DeveloperPolicy.rst

Show First 20 Lines • Show All 554 Lines • ▼ Show 20 Lineswill only be done through the following process:
* Start using the new features in LLVM's codebase. * Start using the new features in LLVM's codebase.
Here's a `sample RFC Here's a `sample RFC
<http://lists.llvm.org/pipermail/llvm-dev/2019-January/129452.html>`_ and the <http://lists.llvm.org/pipermail/llvm-dev/2019-January/129452.html>`_ and the
`corresponding change <https://reviews.llvm.org/D57264>`_. `corresponding change <https://reviews.llvm.org/D57264>`_.
.. _new-llvm-components: .. _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
azharuddUnsubmitted
Done
ReplyInline Actions
--------------------------
- The main continuous integration (CI) tool for the LLVM project are the
- `BuildBots <https://lab.llvm.org/buildbot/>`_. These use different *builders* to
+ The main continuous integration (CI) tool for the LLVM project is the
+ `LLVM Buildbot <https://lab.llvm.org/buildbot/>`_. It uses different *builders* to
cover a wide variety of sub-projects and configurations. The builds are executed
azharudd:
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. This means that patches are
gkistanovaUnsubmitted
Done
ReplyInline Actions

There is a set of builders with the name suffix "-release", for example https://lab.llvm.org/buildbot/#/builders/clang-with-thin-lto-ubuntu-release. These builders track the commits on the release branches to do the release testing.

gkistanova: There is a set of builders with the name suffix "-release", for example https://lab.llvm.
azharuddUnsubmitted
Done
ReplyInline Actions
community members.
- The BuildBots track the commits on the main branch and the release branches.
+ The buildbot tracks 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
azharudd:
built and tested after they are merged to the main branch (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 (see below)
* 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@llvm.org`.
There are other CI 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/>`_
* `gn bot <http://45.33.8.238/>`_
* `pre-merge testing <https://github.com/google/llvm-premerge-checks/>`_
Introducing New Components into LLVM Introducing New Components into LLVM
==================================== ====================================
fhahnUnsubmitted
Done
ReplyInline Actions

I'm not sure about the official status of green dragon, but I think in practice breaking one of those is considered similar to breaking bots at https://lab.llvm.org/buildbot/ (most bots for various Apple platforms are on green dragon rather than https://lab.llvm.org/buildbot)

fhahn: I'm not sure about the official status of green dragon, but I think in practice breaking one of…
kuhnelAuthorUnsubmitted
Done
ReplyInline Actions

I'm also not aware of any official policy around green dragons. So as I did not find any policy, I would assume they are optional as well...

kuhnel: I'm also not aware of any official policy around green dragons. So as I did not find any policy…
gkistanovaUnsubmitted
Done
ReplyInline Actions

LNT is a performance tracking system, not quite a CI.

gkistanova: LNT is a performance tracking system, not quite a CI.
The LLVM community is a vibrant and exciting place to be, and we look to be The LLVM community is a vibrant and exciting place to be, and we look to be
inclusive of new projects and foster new communities, and increase inclusive of new projects and foster new communities, and increase
azharuddUnsubmitted
Done
ReplyInline Actions

I think it is best to just remove this part.

  • Issues reported by any CI system are to be fixed
  • LNT is not CI, whereas this section is talking about CI system
  • pre-merge testing is optional, covers only Phab reviews and already posts updates on the review
azharudd: I think it is best to just remove this part. - Issues reported by any CI system are to be…
kuhnelAuthorUnsubmitted
Done
ReplyInline Actions

you're right, this does not really add value here.

kuhnel: you're right, this does not really add value here.
collaboration across industry and academia. collaboration across industry and academia.
That said, we need to strike a balance between being inclusive of new ideas and That said, we need to strike a balance between being inclusive of new ideas and
people and the cost of ongoing maintenance that new code requires. As such, we people and the cost of ongoing maintenance that new code requires. As such, we
have a general :doc:`support policy<SupportPolicy>` for introducing major new have a general :doc:`support policy<SupportPolicy>` for introducing major new
components into the LLVM world, depending on the degree of detail and components into the LLVM world, depending on the degree of detail and
responsibility required. *Core* projects need a higher degree of scrutiny responsibility required. *Core* projects need a higher degree of scrutiny
than *peripheral* projects, and the latter may have additional differences. than *peripheral* projects, and the latter may have additional differences.
▲ Show 20 Lines • Show All 463 Lines • Show Last 20 Lines