Merge pull request buildbot#7243 from p12tic/release

Release notes for 3.10.0
p12tic · Dec 4, 2023 · 4c55b1c · 4c55b1c
2 parents 8301a6a + eecb159
commit 4c55b1c
Show file tree

Hide file tree

Showing 37 changed files with 100 additions and 54 deletions.
diff --git a/master/docs/manual/upgrading/4.0-upgrade.rst b/master/docs/manual/upgrading/4.0-upgrade.rst
@@ -96,3 +96,13 @@ Endpoint attributes
 
 ``buildbot.data.base.Endpoint`` no longer provides ``isRaw`` and ``isCollection`` attributes.
 The equivalent in Buildbot 4.x is setting the ``kind`` attribute to ``EndpointKind.RAW`` and ``EndpointKind.COLLECTION`` respectively.
+
+Changes to BuildStep attributes
+-------------------------------
+
+BuildBot no longer supports changing ``BuildStep`` attributes after a step is created during configuration.
+Changing attributes of BuildStep instances that are not yet part of any build is most likely an error.
+This is because such instances are only being used to configure a builder as a source to create real steps from.
+In this scenario any attribute changes are ignored as far as build configuration is concerned.
+
+For customizing BuildStep after an instance has already been created `set_step_arg(name, value)` function has been added.
diff --git a/master/docs/relnotes/index.rst b/master/docs/relnotes/index.rst
@@ -8,6 +8,96 @@ Release Notes
 
 .. towncrier release notes start
 
+Buildbot ``3.10.0`` ( ``2023-12-04`` )
+======================================
+
+Bug fixes
+---------
+
+- ``buildbot.changes.bitbucket.BitbucketPullrequestPoller`` has been updated to emit the change files.
+- Fixed build status key sent to Bitbucket exceeding length limits (:issue:`7049`).
+- Fixed a race condition resulting in ``EXCEPTION`` build results when build steps that are about to end are cancelled.
+- Buildrequests are now selected by priority and then by buildrequestid (previously, Buildbot used the age as the secondary sort parameter).
+  This preserves the property of choosing the oldest buildrequest, but makes it predictable which buildrequest will be selected, as there might be multiple buildrequests with the same age.
+- Fixed worker to fail a step ``uploadDirectory`` instead of throwing an exception when directory is not available. (:issue:`5878`)
+- Added missing ``parent_buildid`` and ``parent_relationship`` keys to the buildset completion event in the Data API.
+- Improved handling of Docker containers that fail before worker attaches to master.
+  In such case build will be restarted immediately instead of waiting for a timeout to expire.
+- Enhanced the accessibility of secret files by enabling group-readability.
+  Previously, secret files were exclusively accessible to the owner. Now,
+  accessibility has been expanded to allow group members access as well. This
+  enhancement is particularly beneficial when utilizing Systemd's LoadCredential
+  feature, which configures secrets with group-readable (0o440) permissions.
+- ``MailNotifier`` now works correctly when SSL packages are installed but ``useTls=False`` and auth (``smtpUser``, ``smtpPassword``) is not set. (:issue:`5609`)
+- - `P4` now reports the correct `got_revision` when syncing a changelist that only delete files
+- - `P4` step now use the rev-spec format `//{p4client}/...@{revision}` when syncing with a revision
+- Fixed incorrect propagation of option ``--proxy-connection-string`` into buildbot.tac when creating new Worker.
+- Fixed link to Builder in React Grid View.
+- Addressed a number of timing errors in ``Nightly`` scheduler by upgrading ``croniter`` code.
+
+Changes
+-------
+
+- Buildbot will render step properties and check if step should be skipped before acquiring locks.
+  This allows to skip waiting for locks in case step is skipped.
+- The ``isRaw`` and ``isCollection`` attributes of the ``Endpoint`` type have been deprecated.
+  ``Endpoint`` is used to extend the Buildbot API.
+  Us a replacement use the new ``kind`` attribute.
+- ``AbstractLatentWorker.check_instance()`` now accepts error message being supplied in case instance is not good.
+  The previous API has been deprecated.
+- The published Docker image for the worker now uses Debian 11 (Bullseye) as base image.
+- The published Docker image for the worker now runs Buildbot in virtualenv.
+
+Improved Documentation
+----------------------
+
+- Describe an existing bug with Libvirt latent workers that does not use a copy of the image (:issue `7122`).
+
+Features
+--------
+
+- The new React-based web frontend is no longer experimental.
+  To enable please see :ref:`the documentation on upgrading to 4.0 <4.0_Upgrading>` for more information.
+  The new web frontend includes the following improvements compared to legacy AngularJS web frontend:
+
+    - Project support (initially released in Buildbot 3.9.0).
+    - Steps now show the amount of time spent waiting for locks.
+    - The log viewer now supports huge logs without problems.
+    - The log viewer now includes a search box that downloads entire log on-demand without additional button click.
+    - The log viewer now supports downloading log file both as a file and also showing it inline in the browser.
+    - The colors of the website can be adjusted from Buildbot configuration via ``www["theme"]`` key.
+    - Buildsteps and pending buildrequests have anchor links which allows linking directly to them from external web pages.
+
+- Workers can now be created to use ``connection string`` right out of the box when new option ``--connection-string=`` is used.
+- Docker Latent workers will now show last logs in Buildbot UI when their startup fails.
+- Added ``EndpointKind.RAW_INLINE`` data API endpoint type which will show the response data inline in the browser instead of downloading as a file.
+- Implemented a way to specify volumes for containers spawned by ``KubeLatentWorker``.
+- ``Nightly`` scheduler now supports forcing builds at specific times even if ``onlyIfChanged`` parameter was true and there were no important changes.
+- ``buildbot.steps.source.p4.P4`` can now take a ``p4client_type`` argument to set the client type (More information on client type [here](https://www.perforce.com/manuals/p4sag/Content/P4SAG/performance.readonly.html))
+- Added data and REST APIs to retrieve only projects with active builders.
+- Improved step result reporting to specify whether step failed due to a time out.
+- Added ``tags`` option to the ``Git`` source step to download tags when updating repository.
+- Worker now sends ``failure_reason`` update when the command it was running timed out.
+
+Deprecations and Removals
+-------------------------
+
+- Legacy AngularJS web frontend will be removed in Buildbot 4.0.
+  Fixes to React web frontend that are regressions from AngularJS web frontend will be backported to 3.x Buildbot series to make migration easier.
+- Buildbot Master now requires Python 3.8 or newer.
+  Python 3.7 is no longer supported.
+- ``buildbot.util.croniter`` module has been deprecated in favor of using Pypi ``croniter`` package.
+- ``master.data.updates.setWorkerState()`` has been deprecated.
+  Use ``master.data.updates.set_worker_paused()`` and ``master.data.updates.set_worker_graceful()`` as replacements.
+- Buildbot now requires ``docker`` of version v4.0.0 or newer for Docker support.
+- BuildStep instances are now more strict about when their attributes can be changed.
+  Changing attributes of BuildStep instances that are not yet part of any build is most likely an error.
+  This is because such instances are only being used to configure a builder as a source to create real steps from.
+  In this scenario any attribute changes are ignored as far as build configuration is concerned.
+
+  Such changing of attributes has been deprecated and will become an error in the future release.
+
+  For customizing BuildStep after an instance has already been created `set_step_arg(name, value)` function has been added.
 
 Buildbot ``3.9.2`` ( ``2023-09-02`` )
 =====================================

diff --git a/newsfragments/bitbucket-pull-request-poller.bugfix b/newsfragments/bitbucket-pull-request-poller.bugfix
diff --git a/newsfragments/bitbucket_status-reporter-key-length.bugfix b/newsfragments/bitbucket_status-reporter-key-length.bugfix
diff --git a/newsfragments/build-cancel-exceptions.bugfix b/newsfragments/build-cancel-exceptions.bugfix
diff --git a/newsfragments/buildbot-util-croniter.removal b/newsfragments/buildbot-util-croniter.removal
diff --git a/newsfragments/buildrequest-sort.bugfix b/newsfragments/buildrequest-sort.bugfix
diff --git a/newsfragments/buildstep-dont-acquire-locks-if-skipped.change b/newsfragments/buildstep-dont-acquire-locks-if-skipped.change
diff --git a/newsfragments/buildstep-setattr-after-construction.deprecation b/newsfragments/buildstep-setattr-after-construction.deprecation
diff --git a/newsfragments/catch-unwanted-worker-error.bugfix b/newsfragments/catch-unwanted-worker-error.bugfix
diff --git a/newsfragments/create-worker-connection-string.feature b/newsfragments/create-worker-connection-string.feature
diff --git a/newsfragments/data-api-buildset-complete-missing-keys.bugfix b/newsfragments/data-api-buildset-complete-missing-keys.bugfix
diff --git a/newsfragments/data-api-israw-iscollection.change b/newsfragments/data-api-israw-iscollection.change
diff --git a/newsfragments/data-updates-split-worker-state.removal b/newsfragments/data-updates-split-worker-state.removal
diff --git a/newsfragments/docker-latent-worker-early-fail.bugfix b/newsfragments/docker-latent-worker-early-fail.bugfix
diff --git a/newsfragments/docker-min-version.removal b/newsfragments/docker-min-version.removal
diff --git a/newsfragments/docker-startup-failure-logs.feature b/newsfragments/docker-startup-failure-logs.feature
diff --git a/newsfragments/endpointkind-raw-inline.feature b/newsfragments/endpointkind-raw-inline.feature
diff --git a/newsfragments/group-readable-secrets.bugfix b/newsfragments/group-readable-secrets.bugfix
diff --git a/newsfragments/kube-latent-worker-volumes.feature b/newsfragments/kube-latent-worker-volumes.feature
diff --git a/newsfragments/latest-check-instance-message.change b/newsfragments/latest-check-instance-message.change
diff --git a/newsfragments/libvirt-latent-bug.doc b/newsfragments/libvirt-latent-bug.doc
diff --git a/newsfragments/mail-notifier-over-tls-only-when-configured-so.bugfix b/newsfragments/mail-notifier-over-tls-only-when-configured-so.bugfix
diff --git a/newsfragments/min-python-3.8.removal b/newsfragments/min-python-3.8.removal
diff --git a/newsfragments/nightly-force-at-times.feature b/newsfragments/nightly-force-at-times.feature
diff --git a/newsfragments/p4-client-type.feature b/newsfragments/p4-client-type.feature
diff --git a/newsfragments/p4-sync-correct-got-revision-on-deletion-changelist.bugfix b/newsfragments/p4-sync-correct-got-revision-on-deletion-changelist.bugfix
diff --git a/newsfragments/p4-sync-use-client-name.bugfix b/newsfragments/p4-sync-use-client-name.bugfix
diff --git a/newsfragments/projects_active_api.feature b/newsfragments/projects_active_api.feature
diff --git a/newsfragments/proxy-connection-string.bugfix b/newsfragments/proxy-connection-string.bugfix
diff --git a/newsfragments/react-grid-view-builder-link.bugfix b/newsfragments/react-grid-view-builder-link.bugfix
diff --git a/newsfragments/step-report-timeout.feature b/newsfragments/step-report-timeout.feature
diff --git a/newsfragments/steps-source-git-tags.feature b/newsfragments/steps-source-git-tags.feature
diff --git a/newsfragments/upstream-croniter.bugfix b/newsfragments/upstream-croniter.bugfix
diff --git a/newsfragments/worker-dockerfile-debian.change b/newsfragments/worker-dockerfile-debian.change
diff --git a/newsfragments/worker-dockerfile-virtualenv.change b/newsfragments/worker-dockerfile-virtualenv.change
diff --git a/newsfragments/worker-failure-reason.feature b/newsfragments/worker-failure-reason.feature