Buildbot

=====================================

Despite the major version bump, Buildbot 1.0.0 does not have major difference with the 0.9 series.
1.0.0 is rather the mark of API stability.
Developers do not foresee a major API break in the next few years like we had for 0.8 to 0.9.

Starting with 1.0.0, Buildbot will follow https://semver.org/ versioning methodology.

Bug fixes
---------

- Cloning :bb:step:`Git` repository with submodules now works with Git < 1.7.6
instead of failing due to the use of the unsupported ``--force`` option.
- :bb:chsrc:`GitHub` hook now properly creates a change in case of new tag or
new branch. :bb:chsrc:`GitHub` changes will have the ``category`` set to
``tag`` when a tag was pushed to easily distinguish from a branch push.
- Fixed issue with :py:meth:`Master.expireMasters` not always honoring its
``forceHouseKeeping`` parameter. (:issue:`3783`)
- Fixed issue with steps not correctly ending in ``CANCELLED`` status when
interrupted.
- Fix maximum recursion limit issue when transferring large files with
``LocalWorker`` (issue:`3014`).
- Added an argument to P4Source that allows users to provide a callable to
convert Perforce branch and revision to a valid revlink URL. Perforce
supplies a p4web server for resolving urls into change lists.
- Fixed issue with ``buildbot_pkg not hanging on yarn step on windows
(:issue:`3890`).
- Fix issue with :bb:cfg:`workers` ``notify_on_missing`` not able to be
configurable as a single string instead of list of string (:issue:`3913`).
- Fixed Builder page should display worker name instead of id (:issue:`3901`).

Features
--------

- Add capability to override the default UI settings (:issue:`3908`)
- All :ref:`Reporters` have been adapted to be able to use :ref:`Secret`.
:bb:chsrc:`SVNPoller` has been adapted to be able to use :ref:`Secret`.
- Implement support for Bitbucket Cloud webhook plugin in
:py:class:`~buildbot.www.hooks.bitbucketcloud.BitbucketCloudEventHandler`
- The ``owners`` property now includes people associated with the changes of
the build (:issue:`3904`).
- The repo source step now syncs with the ``--force-sync`` flag which allows
the sync to proceed when a source repo in the manifest has changed.
- Add support for compressing the repo source step cache tarball with ``pigz``,
a parallel gzip compressor.

============================================

Bug fixes
---------

- Fix worker reconnection fails (3875, 3876)
- Fix umask set to 0 when using LocalWorker (3878)
- Fix Buildbot reconfig, when badge plugin is installed (3879)
- Fix (3865) so that now
:py:class:`~buildbot.changes.svnpoller.SVNPoller` works with paths that
contain valid UTF-8 characters which are not ASCII.

Bug fixes
---------

- Fix builder page not showing any build (:issue:`3820`)
- Fix double Workers button in the menu. (:issue:`3818`)
- Fix bad icons in the worker action dialog.
- Fix url arguments in Buildbot :ref:`Badges` for python3.
- Upgrading to `guanlecoja-ui` version 1.8.0, fixing two issues. Fixed issue
where the console view would jump to the top of page when opening the build
summary dialog (:issue:`3657`). Also improved sidebar behaviour by remembering
previous pinned vs. collapsed state.
- Fixes issue with Buildbot :bb:worker:`DockerLatentWorker`, where Buildbot can kill running
workers by mistake based on the form the worker name (:issue:`3800`).
- Fixes issue with Buildbot :bb:worker:`DockerLatentWorker` not reaping zombies process within its container environment.
- Update requirement text to use the modern "docker" module from the older
"docker-py" module name
- When multiple :bb:cfg:`reporter` or :bb:cfg:`services` are configured with
the same name, an error is now displayed instead of silently discarding all
but the last one :issue:`3813`.
- Fixed exception when using :py:class:`buildbot.www.auth.CustomAuth`

Features
--------

- New Buildbot SVG icons for web UI. The web UI now uses a colored favicon
according to build results (:issue:`3785`).
- ``paused`` and ``graceful`` :ref:`Worker-states` are now stored in the
database.
- :ref:`Worker-states` are now displayed in the web UI.
- Quarantine timers is now using the ``paused`` worker state.
- Quarantine timer is now enabled when a build finish on ``EXCEPTION`` state.
- Standalone binaries for buildbot-worker package are now published for windows and linux (``amd64``).
This allows to run a buildbot-worker without having a python environment.
- New ``buildbot-worker create-worker --maxretries`` for :ref:`Latent-Workers`
to quit if the master is or becomes unreachable.
- Badges can now display `running` as status.
- The database schema now supports cascade deletes for all objects instead of
raising an error when deleting a record which has other records pointing to
it via foreign keys.
- Buildbot can properly find its version if installed from a git archive tarball generated from a tag.
- Enhanced the test suite to add worker/master protocol interoperability tests between python3 and python2.

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

- buildbot.util.ascii2unicode() is removed. buildbot.util.bytes2unicode()
should be used instead.