Skip to content

Commit 3df262f

Browse files
[llvm][Docs] Expand MyFirstTypoFix's post-commit section (#79827)
And link to it from the GitHub guide. Since it fits in the flow of the former document better, but is of interest to those using the GitHub specific guide. This includes some content I wrote for an automated PR comment but I think is useful to have in a single place to link to instead. I have removed some details: * About the waterfall view because it doesn't seem that useful to new contributors and is likely to just seem like constant chaos given how many builds are going on. * The orange bubbles in the console view. I also remember this being the case but whether it was changed, or the web UI is just not loading properly, I now see red builds that were red before that commit. So again, it seems like detail that's not needed for a new contributor.
1 parent 7a51aea commit 3df262f

File tree

2 files changed

+40
-22
lines changed

2 files changed

+40
-22
lines changed

llvm/docs/GitHub.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,17 @@ request will understand that you're rebasing just your patches, and display
170170
this result correctly with a note that a force push did occur.
171171

172172

173+
Problems After Landing Your Change
174+
==================================
175+
176+
Even though your PR passed the pre-commit checks and is approved by reviewers, it
177+
may cause problems for some configurations after it lands. You will be notified
178+
if this happens and the community is ready to help you fix the problems.
179+
180+
This process is described in detail
181+
:ref:`here <MyFirstTypoFix Issues After Landing Your PR>`.
182+
183+
173184
Checking out another PR locally
174185
-------------------------------
175186
Sometimes you want to review another person's PR on your local machine to run

llvm/docs/MyFirstTypoFix.rst

Lines changed: 29 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -448,37 +448,44 @@ Actually, this would be a great time to read the rest of the :ref:`developer
448448
policy <developer_policy>` too.
449449

450450

451-
Post-commit errors
452-
==================
451+
.. _MyFirstTypoFix Issues After Landing Your PR:
452+
453+
Issues After Landing Your PR
454+
============================
453455

454456
Once your change is submitted it will be picked up by automated build
455457
bots that will build and test your patch in a variety of configurations.
456458

457-
You can see all configurations and their current state in a waterfall
458-
view at http://lab.llvm.org/buildbot/#/waterfall. The waterfall view is good
459-
to get a general overview over the tested configurations and to see
460-
which configuration have been broken for a while.
459+
The "console" view at http://lab.llvm.org/buildbot/#/console displays results
460+
for specific commits. If you want to follow how your change is affecting the
461+
build bots, this should be the first place to look.
462+
463+
The columns are build configurations and the rows are individual commits. Along
464+
the rows are colored bubbles. The color of the bubble represents the build's
465+
status. Green is passing, red has failed and yellow is a build in progress.
466+
467+
A red build may have already been failing before your change was committed. This
468+
means you didn't break the build but you should check that you did not make it
469+
any worse by adding new problems.
461470

462-
The console view at http://lab.llvm.org/buildbot/#/console helps to get a
463-
better understanding of the build results of a specific patch. If you
464-
want to follow along how your change is affecting the build bots, **this
465-
should be the first place to look at**.
471+
.. note::
472+
Only recent changes are shown in the console view. If your change is not
473+
there, rely on PR comments and build bot emails to notify you of any problems.
466474

467-
Note: only recent changes are shown in the console view. So if your change
468-
is not there, please rely on PR comments and buildbot emails to notify you
469-
of any issues intead.
475+
If there is a problem in a build that includes your changes, you may receive
476+
a report by email or as a comment on your PR. Please check whether the problem
477+
has been caused by your changes specifically. As builds contain changes from
478+
many authors and sometimes fail due to unrelated infrastructure problems.
470479

471-
The colored bubbles correspond to projects in the waterfall. If you see a broken
472-
build, do not despair - some build bots are
473-
continuously broken; if your change broke the build, you will see a red
474-
bubble in the console view, while an already broken build will show an
475-
orange bubble. Of course, even when the build was already broken, a new
476-
change might introduce a hidden new failure.
480+
To see the details of a build, click the bubble in the console view, or the link
481+
provided in the problem report. You will be able to view and download logs for
482+
each stage of that build.
477483

478-
When you want to see more details how a specific build is broken, click the red bubble.
479-
If the error logs confuse you, do not worry - you can ask for help by adding a comment
480-
to your PR, or asking on `Discord <https://discord.com/invite/xS7Z362>`__.
484+
If you need help understanding the problem, or have any other questions, you can
485+
ask them as a comment on your PR, or on `Discord <https://discord.com/invite/xS7Z362>`__.
481486

487+
If you do not receive any reports of problems, no action is required from you.
488+
Your changes are working as expected, well done!
482489

483490
Reverts
484491
-------

0 commit comments

Comments
 (0)