[llvm][docs] Expand HowToAddABuilder with guidance on testing locally #115024
Conversation
Once <llvm/llvm-zorg#289> and <llvm/llvm-zorg#293> land, it's quite reasonable to ask people to test their builder configurations locally. This patch adds documentation on how to do so. I think review at this stage is useful, but of course if there's more review feedback on <llvm/llvm-zorg#289> it's possible some details may change. This won't be committed until those llvm-zorg PRs land of course.
asb
force-pushed
the
2024q4-document-buildmaster-test-mode
branch
from
6cbd198 to
f31341c
Compare
|
This is beside the point of this change but I wonder if this document could do with a note at the start to the effect that the "master" terminology is what the Buildbot project uses and is therefore used here in that context (see buildbot/buildbot#5382). Since we have precedent for not using the term ourselves, when we moved the master branch to main. |
This makes it (relatively) easy to test a builder setup locally. The buildmaster and the web interface should be bound only to local interfaces for security reasons (you can use ssh port forwarding if wanting to run on a server). See llvm/llvm-project#115024 for instructions on how to use, but note #293 is needed to avoid disabling certain builders or needing to hack your local buildbot install.
|
Thank you for the detailed and thoughtful suggestions - I believe I've addressed them all now. |
Yes, I've simply followed what we already do in LLVM by using "buildmaster" as upstream buildbot does (though they did of course rename "buildslave" to "worker"). I'm not sure what the right thing is here. |
asb
force-pushed
the
2024q4-document-buildmaster-test-mode
branch
from
d8a5e75 to
4950b7c
Compare
I've submitted a PR to weak the naming of the environment variable to just BUILDBOT_TEST as I think that's sufficiently descriptive and wouldn't require renaming either downstream in LLVM or in buildbot upstream. llvm/llvm-zorg#301 |
DavidSpickett
changed the title
Adding a note at the start would be my choice, I'll make a PR for it. |
llvm/docs/HowToAddABuilder.rst
Outdated
|
|
||
| * Either wait until the poller sets off a build, or alternatively force a | ||
| build to start in the web UI (which is also the best place to review the | ||
| build results). |
There was a problem hiding this comment.
Reviewing the results seems like a step in itself to me so break out the parenthetical into its own bullet point.
llvm/docs/HowToAddABuilder.rst
Outdated
|
|
||
| .. code-block:: bash | ||
|
|
||
| ssh -N -L 8011:localhost:8011 -L 9990:localhost:9990 username@server_address |
There was a problem hiding this comment.
buildmaster_server_address to be extra clear here.
|
Thank you, made those final tweaks and reflected the change to BUILDBOT_TEST now the relevant PR in llvm-zorg landed. I'll hold off merging until llvm/llvm-zorg#293 as the instructions don't work without that fix sadly. |
|
LLVM Buildbot has detected a new failure on builder Full details are available at: https://lab.llvm.org/buildbot/#/builders/196/builds/931 Here is the relevant piece of the build log for the reference |
Once llvm/llvm-zorg#289 and llvm/llvm-zorg#293 land, it's quite reasonable to ask people to test their builder configurations locally. This patch adds documentation on how to do so.
I think review at this stage is useful, but of course if there's more review feedback on llvm/llvm-zorg#289 it's possible some details may change. This won't be committed until those llvm-zorg PRs land of course.