Buildbot

Bug fixes
---------

- Command `buildbot-worker create-worker` now supports ipv6 address for buildmaster connection.
- Fix crash in latent worker stopService() when the worker is insubstantiating (4935).
- Fix race condition between latent worker's stopService() and substantiate().
- :class:`GitHubAuth` is now using `Authorization` headers instead of `access_token` query parameter, as the latter was deprecated by Github. (5188)
- ``jQuery`` and ``$`` are available again as a global variable for UI plugins (5161).
- Latent workers will no longer wait for builds to finish when worker is reconfigured.
The builds will still be retried on other workers and the operators will not need to potentially wait multiple hours for builds to finish.
- p4poller will no longer override Perforce login ticket handling behavior which fixes random crashes (5042).

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

- The procedures of upgrading to Buildbot 1.x and 2.x have been clarified in separate documents.
- The layout of the specification of the REST API has been improved.
- Updated newsfragments README.txt to no longer refer to renamed class `buildbot.reporters.http.HttpStatusBase`
- The documentation now uses the read-the-docs theme which is more readable.

Features
--------

- A new www badges style was added: ``badgeio``
- `buildbot.reporters.http.HttpStatusPushBase` now allows you to skip unicode to bytes encoding while pushing data to server
- New ``buildbot-worker create-worker --delete-leftover-dirs`` option to automatically remove obsolete builder directories

Bug fixes
---------

- Fix a potential deadlock when interrupting a step that is waiting for a lock to become available.
- Prepare unique hgpoller name when using multiple hgpoller for multiple branches (5004)
- Fix hgpoller crash when force pushing a branch (4876)
- Fix mail recipient formatting to make sure address comments are separately escaped instead of escaping the whole To: or CC: header, which is not RFC compliant.
- Master side keep-alive requests are now repeated instead of being single-shot (3630).
- The message queues will now wait until the delivered callbacks are fully completed during shutdown.
- Fix encoding errors during `P4Poller` ticket parsing 5148.
- Remove server header from HTTP response served by the web component.
- Fix multiple race conditions in Telegram reporter that were visible in tests.
- The Telegram reporter will now wait until in-progress polls finish during shutdown.
- Improve reliability of timed scheduler.
- transfer steps now correctly report errors from workers 5058.
- Warn if Buildbot title in the configuration is too long and will be ignored.
- Worker will now wait for any pending keep-alive requests to finish leaving them in indeterminate state during shutdown.

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

- Mention that `QueueRef.stopConsuming()` may return a Deferred.

Features
--------

- Add the parameter --use-tls to `buildbot-worker create-worker` to automatically enable TLS in the connection string
- Gerrit reporter now passes a tag for versions that support it.
This enables filtering out buildbot's messages.
- `GerritEventLogPoller` and `GerritChangeSource` coordinate so as not to generate duplicate changes, resolves 4786.
- Web front end now allows you to configure the default landing page with `c['www']['default_page'] = 'name-of-page'`.
- The new option `dumpMailsToLog` of `MailNotifier` allows to dump formatted mails to the log before sending.
- Workers will now attempt to read `/etc/os-release` and stores them into worker info as `os_<field>` items.
Add new interpolation `worker` that can be used for accessing worker info items.

Bug fixes
---------

- Updates supported browser list so that Ubuntu Chromium will not always be flagged as out of date.
- Fixed IRC notification color of cancelled builds.
- Updated url in description of worker service for Windows (no functionality impact).
- Updated templates of www-badges to support additional padding configuration (5079)
- Fix issue with custom_templates loading path (5035)
- Fix url display when step do not contain any logs (5047)

Bug fixes
---------

- Fix crash when reconfiguring changed workers that have new builders assigned to them (:issue:`4757`, :issue:`5027`).
- DockerLatentWorker: Allow to bind the same volume twice into a worker's container, Buildbot now requires 'docker-py' (nowadays 'docker') version 1.2.3+ from 2015.
- IRC bot can have authz configured to create or stop builds (:issue:`2957`).
- Fix javascript exception with grid view tag filtering (:issue:`4801`)

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

- Changed PluginList link from trac wiki directly to the GitHub wiki.

Features
--------

- Created a `TelegramBot` for notification and control through Telegram messaging app.
- Added support for environment variable P4CONFIG to class ``P4Source``
- Allow to define behavior for GitCommit when there is nothing to commit.
- Add support for revision links to Mercurial poller
- Support recursive matching ('**') in MultipleFileUpload when `glob=True` (requires python3.5+ on the worker)

Bug fixes
---------

- allow committer of a change to be null for new setups (:issue:`4987`)
- custom_templates are now working again.
- Locks will no longer allow being acquired more times than the `maxCount` parameter if this parameter is changed during master reconfiguration.

Features
--------

- Improve log cleaning performance by using delete with join on supported databases.
- Hiding/showing of inactive builders is now possible in Waterfall view.

Highlights
----------

Database upgrade may take a while on larger instances on this release due to newly added index.

Bug fixes
---------

- Add an index to `steps.started_at` to boost expensive SQL queries.
- Fix handling of the `refs_changed` event in the BitBucket Server web hook.
- Fix errors when disconnecting a libvirt worker (issue 4844).
- Fix Bitbucket Cloud hook crash due to changes in their API (issue 4873).
- Fix `GerritEventLogPoller` was using the wrong date format.
- Fix janitor Exception when there is no logchunk to delete.
- Reduced the number of SQL queries triggered by `getPrevSuccessfulBuild()` by up to 100.
- `buildbot.util.git.GitStepMixin`: Prevent builders from corrupting temporary ssh data path by using builder name as part of the path
- `buildbot.util.git.GitTag`: Allow `tagName` to be a renderable.
- Fix Github error reporting to handle exceptions that happen before the HTTP request is sent.
- `buildbot.changes.gitpoller.GitPoller`: Trigger on pushes with no commits when the new revision is not the tip of another branch.
- `buildbot.steps.source.git.Git`: Fix the invocation of `git submodule foreach` on cleaning.
- Fix StatsService not correctly clearing old consumers on reconfig.
- Fix various errors in try client with Python 3 (issue 4765).
- Prevent accidental start of multiple force builds in web UI (issue 4823).
- The support for proxying Buildbot frontend to another Buildbot instance during development has been fixed.
This feature has been broken since v2.3.0, and is now completely re-implemented for best performance, ease of use and maintainability.

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

- Document why some listed icons may not work out-of-the-box when building a custom dashboard (issue 4939).
- Improve Vault secrets management documentation and examples.
- Link the documentation of `www.port` to the capabilities of `twisted.application.strports`.
- Move the documentation on how to submit PRs out of the trac wiki to the documentation shipped with Buildbot, update and enhance it.

Features
--------

- Update buildbot worker image to Ubuntu 18.04 (issue 4928).
- `buildbot.worker.docker.DockerLatentWorker`: Added support for docker build contexts, `buildargs`, and specifying controlling context.
- The `buildbot.changes.gerritchangesource.GerritChangeFilter` and `buildbot.changes.gerritchangesource.GerritEventLogPoller` now populate the `files` attribute of emitted changes when the `get_files` argument is true. Enabling this feature triggers an additional HTTP request or SSH command to the Gerrit server for every emitted change.
- Buildbot now warns users who connect using unsupported browsers.
- Boost janitor speed by using more efficient SQL queries.
- Scheduler properties are now renderable.
- `buildbot.steps.python.Sphinx`: Added `strict_warnings` option to fail on warnings.
- UI now shows a paginated view for trigger step sub builds.

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

- Support for older browsers that were not working since 2.3.0 has been removed due to technical limitations.
Notably, Internet Explorer 11 is no longer supported.
Currently supported browsers are Chrome 56, Firefox 52, Edge 13 and Safari 10, newer versions of these browsers and their compatible derivatives.
This set of browsers covers 98% of users of buildbot.net.