Release Notes for Buildbot ``|version|``
========================================

..
    Any change that adds a feature or fixes a bug should have an entry here.
    Most simply need an additional bulleted list item, but more significant
    changes can be given a subsection of their own.

    If you can:

       please point to the bug using syntax: (:bug:`NNN`)
       please point to classes using syntax: :py:class:`~buildbot.reporters.http.HttpStatusBase`

..
    NOTE: When releasing 0.9.0, combine these notes with those from 0.9.0b*
    into one single set of notes.  Also, link prominently to the migration guide.

The following are the release notes for Buildbot ``|version|``.

See :ref:`Upgrading to Nine` for a guide to upgrading from 0.8.x to 0.9.x

Master
------

* Add support for hyper.sh via :class:`HyperLatentWorker`
  Hyper_ is a CaaS solution for hosting docker container in the cloud, billed to the second.
  It forms a very cost efficient solution to run your CI in the cloud.

.. _Hyper: https://hyper.sh

* add tool to send usage data to buildbot.net :bb:cfg:`buildbotNetUsageData`

Features
~~~~~~~~

* The :bb:step:`Trigger` step now supports ``unimportantSchedulerNames``

* add a UI button to allow to cancel the whole queue for a builder

* Buildbot log viewer now support 256 colors ANSI codes

* new :bb:step:`GitHub` which correctly checkout the magic branch like ``refs/pull/xx/merge``.

* :class:`MailNotifier` now supports a `schedulers` constructor argument that
  allows you to send mail only for builds triggered by the specified list of
  schedulers.

* :class:`MailNotifier` now supports a `branches` constructor argument that
  allows you to send mail only for builds triggered by the specified list of
  branches.

* Optimization of the data api filtering, sorting and paging, speeding up a lot the UI when the master has lots of builds.

Fixes
~~~~~

* fix the UI to allow to cancel a buildrequest (:bug:`3582`)

* :bb:chsrc:`GitHub` change hook now correctly use the refs/pull/xx/merge branch for testing PRs.

* Fix the UI to better adapt to different screen width (:bug:`3614`)

Changes for Developers
~~~~~~~~~~~~~~~~~~~~~~

Features
~~~~~~~~

Fixes
~~~~~


Deprecations, Removals, and Non-Compatible Changes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* By default, non-distinct commits received via
  :class:`buildbot.status.web.hooks.github.GitHubEventHandler` now get recorded
  as a :class:`Change`. In this way, a commit pushed to a branch that is not
  being watched (e.g. a dev branch) will still get acted on when it is later
  pushed to a branch that is being watched (e.g. master). In the past, such a
  commit would get ignored and not built because it was non-distinct. To disable
  this behavior and revert to the old behavior, install a :class:`ChangeFilter`
  that checks the ``github_distinct`` property:

.. code-block:: python

  ChangeFilter(filter_fn=lambda c: c.properties.getProperty('github_distinct'))


* setup.py 'scripts' have been converted to console_scripts entry point.
  This makes them more portable and compatible with wheel format.
  Most consequences are for the windows users:

  * ``buildbot.bat`` does not exist anymore, and is replaced by ``buildbot.exe``, which is generated by the console_script entrypoint.

  * ``buildbot_service.py`` is replaced by ``buildbot_windows_service.exe``, which is generated by the console_script entrypoint
    As this script has been written in 2006, has only inline documentation and no unit tests, it is not guaranteed to be working.
    Please help improving the windows situation.

Buildslave
----------

Deprecations, Removals, and Non-Compatible Changes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~


Worker
------

Fixes
~~~~~

Changes for Developers
~~~~~~~~~~~~~~~~~~~~~~

Deprecations, Removals, and Non-Compatible Changes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

* setup.py 'scripts' have been converted to console_scripts entry point.
  This makes them more portable and compatible with wheel format.
  Most consequences are for the windows users:

  * ``buildbot_worker.bat`` does not exist anymore, and is replaced by ``buildbot_worker.exe``, which is generated by the console_script entrypoint.

  * ``buildbot_service.py`` is replaced by ``buildbot_worker_windows_service.exe``, which is generated by the console_script entrypoint
    As this script has been written in 2006, has only inline documentation and no unit tests, it is not guaranteed to be working.
    Please help improving the windows situation.


Details
-------

For a more detailed description of the changes made in this version, see the git log itself:

.. code-block:: bash

   git log v0.9.0rc1..master

Older Versions
--------------

Release notes for older versions of Buildbot are available in the :src:`master/docs/relnotes/` directory of the source tree.
Newer versions are also available here:

.. toctree::
    :maxdepth: 1

    0.9.0
    0.9.0rc4
    0.9.0rc3
    0.9.0rc2
    0.9.0rc1
    0.9.0b9
    0.9.0b8
    0.9.0b7
    0.9.0b6
    0.9.0b5
    0.9.0b4
    0.9.0b3
    0.9.0b2
    0.9.0b1
    0.8.12
    0.8.10
    0.8.9
    0.8.8
    0.8.7
    0.8.6

Note that Buildbot-0.8.11 was never released.