Buildbot v2.9.0 Release Notes
Release Date: 2020-12-04 // over 3 years ago-
๐ Bug fixes
- ๐ Fixed a bug preventing the
timeout=None
parameter of CopyDirectory step from having effect (#3032). - ๐ Fixed a bug in
GitHubStatusPush
that would cause silent failures for builders that specified multiple codebases. - ๐ Fixed display refresh of breadcrumb and topbar contextual action buttons (#5549)
- ๐ Throwing an exception out of a log observer while processing logs will now correctly fail the step in the case of new style steps.
- ๐ Fixed an issue where
git fetch
would break on tag changes by adding the-f
option. This could previously be handled by manually specifyingclobberOnFailure
, but as that is rather heavy handed and off by default, this new default functionality will keep Buildbot in sync with the repository it is fetching from. - ๐ Fixed
GitHubStatusPush
logging an error when triggered by the NightlyScheduler - ๐ Fixed GitHub webhook event handler when no token has been set
- ๐ Fixed
HashiCorpVaultSecretProvider
reading secrets attributes, when they are not namedvalue
- ๐ Fixed
buildbot.changes.HgPoller
misuse ofhg heads -r <branch>
tohg heads <branch>
because-r
option shows heads that may not be on the wanted branch. - ๐ Fixed inconsistent REST api, buildid vs build_number, #3427
- ๐ Fixed permission denied in
rmtree()
usage inPrivateTemporaryDirectory
on Windows - ๐ Fixed AssertionError when calling try client with
--dryrun
option (#5618). - ๐ Fixed issue with known hosts not working when using git with a version less than 2.3.0
- โฑ
ForceScheduler
now gets Responsible Users from owner property (#3476) - โ Added support for
refs/pull/###/head
ref for fetching the issue ID in the GitHub reporter instead of always expectingrefs/pull/###/merge
. - ๐ Fixed Github v4 API URL
- Fixed
show_old_builders
to have expected effects in the waterfall view. - ๐ Latent workers no longer reuse the started worker when it's incompatible with the requested build.
- ๐ Fixed handling of submission of non-decoded
bytes
logs in new style steps. - โ Removed usage of
distutils.LooseVersion
is favor ofpackaging.version
- โก๏ธ Updated
OpenstackLatentWorker
to use checkConfig/reconfigService structure. - ๐ Fixed
OpenstackLatentWorker
to use correct method when listing images.
โก๏ธ UpdatedOpenstackLatentWorker
to support renderableflavor
,nova_args
andmeta
. - ๐ Fixed support of renderables for
p4base
andp4branch
arguments of the P4 step. - ๐ Buildbot now uses pypugjs library instead of pyjade to render pug templates.
- โก๏ธ Step summary is now updated after the last point where the step status is changed.
๐ฒ Previously exceptions in log finish methods would be ignored. - Transfer steps now return
CANCELLED
instead ofSUCCESS
when interrupted. - ๐ Fixed bytes-related master crash when calling buildbot try (#4488)
- ๐ The waterfall modal is now closed upon clicking build summary link
- ๐ท The worker will now report low level cause of errors during the command startup.
๐ Improved Documentation
- โ Added documentation of how to log to stdout instead of twistd.log.
- โ Added documentation of how to use pdb in a buildbot application.
- ๐ Fixed import path for plugins
- โ Added documentation about vault secrets handling.
๐ Features
- โ Added UpCloud latent worker
buildbot.worker.upcloud.UpCloudLatentWorker
- ๐ The init flag is now allowed to be set to false in the host config for
buildbot.plugins.worker.DockerLatentWorker
- โ Added ability for the browser to auto-complete force dialog form fields.
- AvatarGitHub class has been implemented, which lets us display the user's GitHub avatar.
- ๐ New reporter has been implemented
buildbot.reporters.bitbucketserver.BitbucketServerCoreAPIStatusPush
.
๐ Reporting build status has been integrated into BitbucketServer Core REST API in Bitbucket Server 7.4.
๐ Old BitbucketServer Build REST API is still working, but does not provide the new and improved functionality. - ๐ A per-build key-value store and related APIs have been created for transient and potentially large per-build data.
- โฌ๏ธ Buildbot worker docker image has been upgraded to
python3
. - โ Added the ability to copy build properties to the clipboard.
- The
urlText
parameter to theDirectoryUpload
step is now renderable. - โ Added the option to hide sensitive HTTP header values from the log in
buildbot.steps.http.HTTPStep
. - It is now possible to set
urlText
on a url linked to aMultipleFileUpload
step. - Use
os_auth_args
to pass in authentication forOpenstackLatentWorker
. - ๐
DebPbuilder
,DebCowbuilder
,UbuPbuilder
andUbuCowbuilder
now support renderables for the step parameters. - A new report generator API has been implemented to abstract generation of various reports that are then sent via the reporters.
๐ TheBitbucketServerPRCommentPush
,MailNotifier
,PushjetNotifier
andPushoverNotifier
support this new API via their newgenerators
parameter. - โ Added rules for Bitbucket to default revlink helpers.
- โ Added counts of the statuses of the triggered builds to the summary of trigger steps
- ๐ท The worker preparation step now shows the worker name.
๐ Deprecations and Removals
๐
buildbot.test.fake.httpclientservice.HttpClientService.getFakeService()
has been deprecated. UsegetService
method of the same class.๐ The
MTR
step has been deprecated due to migration to new style steps and the build result APIs. The lack of proper unit tests made it too time-consuming to migrate this step along with other steps. Contributors are welcome to step in, migrate this step and add a proper test suite so that this situation never happens again.๐ Many steps have been migrated to new style from old style.
๐ This only affects users who use steps as base classes for their own steps. New style steps provide a completely different set of functions that may be overridden. Direct instantiation of step classes is not affected. Old and new style steps work exactly the same in that case and users don't need to do anything.
๐ The old-style steps have been deprecated since Buildbot v0.9.0 released in October 2016. The support for old-style steps will be removed entirely Buildbot v3.0.0 which will be released in near future. Users are advised to upgrade their custom steps to new-style steps as soon as possible.
๐ A gradual migration path is provided for steps that are likely to be used as base classes. Users need to inherit from
<StepName>NewStyle
class and convert all overridden APIs to use new-style step APIs. The old-style<StepName>
classes will be provided until Buildbot v3.0.0 release. In Buildbot v3.0.0<StepName>
will refer to new-style steps and will be equivalent to<StepName>NewStyle
.<StepName>NewStyle
aliases will be removed in Buildbot v3.2.0.๐ The list of old-style steps that have new-style equivalents for gradual migration is as follows:
Configure
(new-style equivalent isConfigureNewStyle
)Compile
(new-style equivalent isCompileNewStyle
)HTTPStep
(new-style equivalent isHTTPStepNewStyle
)GET
,PUT
,POST
,DELETE
,HEAD
,OPTIONS
(new-style equivalent isGETNewStyle
,PUTNewStyle
,POSTNewStyle
,DELETENewStyle
,HEADNewStyle
,OPTIONSNewStyle
)MasterShellCommand
(new-style equivalent isMasterShellCommandNewStyle
)ShellCommand
(new-style equivalent isShellCommandNewStyle
)SetPropertyFromCommand
(new-style equivalent isSetPropertyFromCommandNewStyle
)WarningCountingShellCommand
(new-style equivalent isWarningCountingShellCommandNewStyle
)Test
(new-style equivalent isTestNewStyle
)
๐ The list of old-style steps that have been converted to new style without a gradual migration path is as follows:
BuildEPYDoc
CopyDirectory
DebLintian
DebPbuilder
DirectoryUpload
FileDownload
FileExists
FileUpload
HLint
JsonPropertiesDownload
JsonStringDownload
LogRenderable
MakeDirectory
MaxQ
Mock
MockBuildSRPM
MsBuild
,MsBuild4
,MsBuild12
,MsBuild14
,MsBuild141
MultipleFileUpload
PerlModuleTest
PyFlakes
PyLint
RemoveDirectory
RemovePYCs
RpmLint
RpmBuild
SetPropertiesFromEnv
Sphinx
StringDownload
TreeSize
Trial
VC6
,VC7
,VC8
,VC9
,VC10
,VC11
,VC12
,VC14
,VC141
VS2003
,VS2005
,VS2008
,VS2010
,VS2012
,VS2013
,VS2015
,VS2017
โ Additionally, all source steps have been migrated to new style without a gradual migration path. Ability to be used as base classes was not documented and thus is considered unsupported. Please submit any custom steps to Buildbot for inclusion into the main tree to reduce maintenance burden. Additionally, bugs can be submitted to expose needed APIs publicly for which a migration path will be provided in the future.
๐ The list of old-style source steps that have been converted to new style is as follows:
Bzr
CVS
Darcs
Gerrit
Git
GitCommit
GitLab
GitPush
GitTag
Monotone
Mercurial
P4
Repo
Source
-
SVN
๐ The undocumented and broken RpmSpec step has been removed.
๐ The usage of certain parameters have been deprecated in
BitbucketServerPRCommentPush
,MailNotifier
,PushjetNotifier
andPushoverNotifier
reporters. They have been replaced by thegenerators
parameter. The support for the deprecated parameters will be removed in Buildbot v3.0.๐ The list of deprecated parameters is as follows:
mode
tags
builders
buildSetSummary
messageFormatter
subject
addLogs
addPatch
schedulers
branches
watchedWorkers
-
messageFormatterMissingWorker
The undocumented
NotifierBase
class has been renamed toReporterBase
.๐ The undocumented
HttpStatusPushBase
class has been deprecated. Please useReporterBase
directly.๐ The
send
method of the reporters based onHttpStatusPushBase
has been deprecated. This affects only users who implemented custom reporters that directly or indirectly deriveHttpStatusPushBase
. Please usesendMessage
as the replacement.The following reporters have been affected:
HttpStatusPush
BitbucketStatusPush
BitbucketServerStatusPush
BitbucketServerCoreAPIStatusPush
GerritVerifyStatusPush
GitHubStatusPush
GitLabStatusPush
HipChatStatusPush
-
ZulipStatusPush
๐ BuildBot now requires SQLAlchemy 1.2.0 or newer.
๐ Deprecation warnings have been added to the
buildbot.status
module. It has been deprecated in documentation since v0.9.0.๐
buildbot.interfaces.WorkerTooOldError
is deprecated in favour ofbuildbot.interfaces.WorkerSetupError
๐ The
worker_transition
module has been removed. - ๐ Fixed a bug preventing the