Buildbot

Bug fixes
---------

- Updated Buildbot requirements to specify sqlalchemy 1.4 and newer as not supported yet.

Bug fixes
---------

- Fixed special character handling in avatar email URLs.
- Added missing report generators to the Buildbot plugin database (5892).
- Fixed non-default mode support in ``BuildSetStatusGenerator``.

Bug fixes
---------

- Optimized builder reconfiguration when configuration does not change. This leads to up to 6 times faster reconfiguration in Buildbot instances with many builders.
- Fixed build steps continuing running commands even if when they have been cancelled.
- Worked around failure to build recent enough cryptography module in the docker image due to too old rust being available.
- Fixed a regression in ``GitHubEventHandler`` since v2.9.0 in that it would require a GitHub token for public repositories (5760).
- Fixed a regression in ``GerritChangeSource`` since v2.6.0 that caused only the first event related to a Gerrit change to be reporter as a change to Buildbot (5596). Now such deduplication will be applied only to ``patchset-created`` and ``ref-updated`` events.
- Reconfiguration reliability has been improved by not reconfiguring WAMP router if settings have not changed.
- Fixed unauthorized login errors when latent worker with automatic password is reconfigured during substantiation.
- Don't deactivate master as seen by the data API before builds are stopped.
- Fixed a race condition that may result in a crash when build request distributor stops when its activity loop is running.
- Fixed a crash when a manual step interruption is happening during master shutdown which tries to stop builds itself.
- Fixed a race condition that may result in a deadlock if master is stopped at the same time a build is started.
- Improved ``buildbot.util.poll.method`` to react faster to a request to stop.
New pending calls are no longer executed.
Calls whose interval but not random delay has already expired are no longer executed.
- Fixed a crash when a trigger step is used in a build with patch body data passed via the try scheduler (5165).
- Fixed secret replacement for an empty string or whitespace which may have many matches and generally will not need to be redacted.
- Fixed exceptions when using LdapUserInfo as avatar provider
- Fixed exceptions when LDAP filter string contains characters that needs to be escaped.

Bug fixes
---------

- Fixed reference to ``tuplematch`` in the ``ReporterBase`` class (5764).
- For build summary tooltip, truncate very long step names or build status strings, enable auto positioning of tooltip, and improve text alignment. Also, add build summary tooltip to masters page and builds tables.
- Fixed crash when using renderable locks with latent workers that may have incompatible builds (5757).
- Improved REST API to use username or full name of a logged in user when email is empty.
- Worked around a bug in Python's urllib which caused Python clients not to accept basic authentication headers (5743)
- Fixed crash in ``BuildStartEndStatusGenerator`` when tags filter is setup (5766).
- Added missing ``MessageFormatterEmpty``, ``MessageFormatterFunction``, ``MessageFormatterMissingWorker``, and ``MessageFormatterRenderable`` to ``buildbot.reporters`` namespace.


Improved Documentation
----------------------

- Fix services config for IRC in tour.

Deprecations and Removals
-------------------------

- Added deprecation messages to the following members of ``buildbot.process.buildstep`` module that have been deprecated in Buildbot 0.8.9:

- ``RemoteCommand``
- ``LoggedRemoteCommand``
- ``RemoteShellCommand``
- ``LogObserver``
- ``LogLineObserver``
- ``OutputProgressObserver``

Highlights
----------

This is the last release in 2.x series. Only 2.10.y bugfix releases will follow. Upgrading existing Buildbot instances to 3.x will require an upgrade to 2.10.y first and resolving all deprecation warnings. Please see [the documentation on upgrading to 3.0](https://buildbot.readthedocs.io/en/v2.10.0/manual/upgrading/3.0-upgrade.html) for more information.

Please submit bug reports for any issues found in new functionality that replaces deprecated functionality to be removed in Buildbot 3.0. These bugs will be fixed with extra priority in 2.10.y bugfix releases.

Bug fixes
---------

- Fixed a bug that caused builds running on latent workers to become unstoppable when an attempt was made to stop them while the latent worker was being substantiated (5136).
- Fixed a bug that caused the buildmaster to be unable to restart if a latent worker was previously reconfigured during its substantiation.
- Fixed handling of very long lines in the logs during Buildbot startup (5706).
- Fixed a bug which prevented polling change sources derived from `ReconfigurablePollingChangeSource` from working correctly with `/change_hook/poller` (5727)

Improved Documentation
----------------------

- Corrected the formatting for the code sample in the Docker Tutorial's Multi-master section.
- Improved the readability of the documentation by conserving horizontal space.
- Improved the introduction and concepts parts of the documentation.

Features
--------

- Added build summary tooltip for build bubbles in grid and console views (4733).
- Added support for custom HTTP headers to `HttpStatusPush` reporter (5398).
- Implemented `MessageFormatterFunction` that creates build report text or json by processing full build dictionary.
- Implemented `MessageFormatterRenderable` that creates build report text by rendering build properties onto a renderable.
- Implemented `BuildStartEndStatusGenerator` which ensures that a report is generated for either both build start and end events or neither of them.
- The `BitbucketServerCoreAPIStatusPush`, `BitbucketServerStatusPush`, `BitbucketStatusPush`, `GerritVerifyStatusPush`, `GitHubStatusPush`, `GitHubCommentPush`, `GitLabStatusPush` and `HttpStatusPush` reporters now support report generators via the `generators` argument.
- Implemented support for remote submodules when cloning a Git repository.

Deprecations and Removals
-------------------------

- The following arguments of `BitbucketServerCoreAPIStatusPush`, `BitbucketServerStatusPush`, `GerritVerifyStatusPush`, `GitHubStatusPush`, `GitHubCommentPush` and `GitLabStatusPush` reporters have been deprecated in favor of the list of report generators provided via the `generators` argument: `startDescription`, `endDescription`, `builders`.
- The following arguments of `BitbucketStatusPush` reporter have been deprecated in favor of the list of report generators provided via the `generators` argument: `builders`.
- The following arguments of `HttpStatusPush` reporter have been deprecated in favor of the list of report generators provided via the `generators` argument: `format_fn`, `builders`, `wantProperties`, `wantSteps`, `wantPreviousBuild`, `wantLogs`.
- `HipChatStatusPush` has been deprecated because the public version of hipchat has been shut down. This reporter will be removed in Buildbot 3.0 unless there is someone who will upgrade the reporter to the new internal APIs present in Buildbot 3.0.
- Support for passing paths to template files for rendering in message formatters has been deprecated.
- Buildbot now requires at least the version 0.13 of sqlalchemy-migrate (5669).
- The `logfile` argument of `ShellArg` has been deprecated (3771).

Bug fixes
---------

- Fixed spam messages to stdout when renderable operators were being used.
- Fixed handling of very long lines in the logs during Buildbot startup (5706).
- Fixed logging of error message to `twistd.log` in case of old git and `progress` option being enabled.

Deprecations and Removals
-------------------------

- Removed setup of unused ``webstatus`` feature of autobahn.