This is an archive of the discontinued LLVM Phabricator instance.

[docs] Improve guidance on installing the correct buildbot-worker version
ClosedPublic

Authored by asb on Feb 21 2023, 2:42 AM.

Details

Summary

The docs currently state that buildbot-worker 2.8.5 is used. However, looking at the buildbot release notes, this release doesn't seem to exist (it's not on PyPI either). The document also links to http://trac.buildbot.net/ as a source to retrieve an old version and install it manually, but this is dead.

Instead, drop that advice and suggest pip3 install buildbot-worker==2.8.4, as done by the Dockerfiles in llvm-zorg/buildbot/google/docker/*.

Diff Detail

Event Timeline

asb created this revision.Feb 21 2023, 2:42 AM
Herald added a project: Restricted Project. · View Herald TranscriptFeb 21 2023, 2:42 AM
asb requested review of this revision.Feb 21 2023, 2:42 AM
Herald added a project: Restricted Project. · View Herald TranscriptFeb 21 2023, 2:42 AM
gkistanova accepted this revision.Feb 21 2023, 10:25 AM

More recent versions of buildbot-worker would work too. But you are right, we shall recommend what would work for sure and what would require less effort to setup.

This revision is now accepted and ready to land.Feb 21 2023, 10:25 AM
asb added a comment.Feb 21 2023, 10:43 AM

Thanks, although I have a follow-up question I've committed as this patch is at least an incremental improvement. Is the recommendation of a certain buildbot version a holdover from an earlier time that should be removed? If we expect the latest version of buildbot-worker to "just work", perhaps we should recommend that?

There is no promise of forward compatibility as far as I know. Thus far I have seen working workers from version 0.8.4 to version 3.7.0. I have also seen people setting up workers from the source code and not any particular release. All this is fine. I don't think we should force everyone to use a particular version as long as that does not affect reliability of the production buildbot, and experiments with newer versions do not require much attention and troubleshooting on the server side. Being flexible with the requirements to workers help bot owners to keep them on their own schedule.

That's a long way of saying that the current wording is Ok, I think. This is mostly for people who are about to set their first worker and looking for a safe bet.