diff --git a/master/docs/relnotes/0.8.11.rst b/master/docs/relnotes/0.8.11.rst new file mode 100644 index 00000000000..c5d7b37a9f5 --- /dev/null +++ b/master/docs/relnotes/0.8.11.rst @@ -0,0 +1,155 @@ +Release Notes for Buildbot 0.8.11 +================================= + +.. + 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. + +The following are the release notes for Buildbot 0.8.11. +Buildbot 0.8.11 was released on XXX. + +Master +------ + +Requirements: + +* Buildbot works python-dateutil >= 1.5 + +Features +~~~~~~~~ + +* GitHub change hook now supports application/json format. + +* Buildbot is now compatible with Gerrit v2.6 and higher. + + To make this happen, the return result of ``reviewCB`` and ``summaryCB`` callback has changed from + + .. code-block:: python + + (message, verified, review) + + to + + .. code-block:: python + + {'message': message, + 'labels': {'label-name': value, + ... + } + } + + The implications are: + + * there are some differences in behaviour: only those labels that were provided will be updated + * Gerrit server must be able to provide a version, if it can't the :bb:status:`GerritStatusPush` will not work + + .. note:: + + If you have an old style ``reviewCB`` and/or ``summaryCB`` implemented, these will still work, however there could be more labels updated than anticipated. + + More detailed information is available in :bb:status:`GerritStatusPush` section. + +* Buildbot now supports plugins. + They allow Buildbot to be extended by using components distributed independently from the main code. + They also provide for a unified way to access all components. + When previously the following construction was used:: + + from buildbot.kind.other.bits import ComponentClass + + ... ComponentClass ... + + the following construction achieves the same result:: + + from buildbot.plugins import kind + + ... kind.ComponentClass ... + + Kinds of components that are available this way are described in :doc:`../manual/plugins`. + + .. note:: + + While the components can be still directly imported as ``buildbot.kind.other.bits``, this might not be the case after Buildbot v1.0 is released. + +* :bb:chsrc:`GitPoller` now supports detecting new branches + +* :bb:step:`MasterShellCommand` now renders the ``path`` argument. + +* :class:`~buildbot.process.buildstep.ShellMixin`: the ``workdir`` can now be overridden in the call to ``makeRemoteShellCommand``. + +* GitHub status target now allows to specify a different base URL for the API (usefule for GitHub enterprise installations). + This feature requires `txgithub` of version 0.2.0 or better. + +* GitHub change hook now supports payload validation using shared secret, see :ref:`GitHub-hook` for details. + +* Added StashStatusPush status hook for Atlassian Stash + +* Builders can now have multiple "tags" associated with them. Tags can be used in various status classes as filters (eg, on the waterfall page). + +* :bb:status:`MailNotifier` no longer forces SSL 3.0 when ``useTls`` is true. + +* GitHub change hook now supports function as codebase argument. + +* GitHub change hook now supports pull_request events. + +* :class:`~buildbot.process.buildstep.Trigger`: the ``getSchedulersAndProperties`` customization method has been backported from Nine. + This provides a way to dynamically specify which schedulers (and the properties for that scheduler) to trigger at runtime. + +Fixes +~~~~~ + +* GitHub change hook now correctly responds to ping events. +* ``buildbot.steps.http`` steps now correctly have ``url`` parameter renderable +* :bb:step:`MasterShellCommand` now correctly logs the working directory where it was run. +* With Git(), force the updating submodules to ensure local changes by the build are overwitten. + This both ensures more consistent builds and avoids errors when updating submodules. +* With Git(), make sure 'git submodule sync' is called before 'git submodule update' to update + stale remote urls (:bb:bug:`2155`). + +Deprecations, Removals, and Non-Compatible Changes +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +* The builder parameter "category" is deprecated and is replaced by a parameter called "tags". + +Changes for Developers +~~~~~~~~~~~~~~~~~~~~~~ + +* :class:`~buildbot.process.buildstep.Trigger`: ``createTriggerProperties`` now takes one argument (the properties to generate). + +* :class:`~buildbot.process.buildstep.Trigger`: ``getSchedulers`` method is no longer used and was removed. + +Slave +----- + +Features +~~~~~~~~ + +Fixes +~~~~~ + +Deprecations, Removals, and Non-Compatible Changes +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Details +------- + +For a more detailed description of the changes made in this version, see the git log itself: + +.. code-block:: bash + + git log v0.8.10..eight + +Older Versions +-------------- + +Release notes for older versions of Buildbot are available in the :bb:src:`master/docs/relnotes/` directory of the source tree. +Newer versions are also available here: + +.. toctree:: + :maxdepth: 1 + + 0.8.10 + 0.8.9 + 0.8.8 + 0.8.7 + 0.8.6 diff --git a/master/docs/relnotes/index.rst b/master/docs/relnotes/index.rst index 4b3e5b7f0ec..34038628116 100644 --- a/master/docs/relnotes/index.rst +++ b/master/docs/relnotes/index.rst @@ -11,112 +11,18 @@ The following are the release notes for Buildbot |version|. Master ------ -Requirements: - -* Buildbot works python-dateutil >= 1.5 - Features ~~~~~~~~ -* GitHub change hook now supports application/json format. - -* Buildbot is now compatible with Gerrit v2.6 and higher. - - To make this happen, the return result of ``reviewCB`` and ``summaryCB`` callback has changed from - - .. code-block:: python - - (message, verified, review) - - to - - .. code-block:: python - - {'message': message, - 'labels': {'label-name': value, - ... - } - } - - The implications are: - - * there are some differences in behaviour: only those labels that were provided will be updated - * Gerrit server must be able to provide a version, if it can't the :bb:status:`GerritStatusPush` will not work - - .. note:: - - If you have an old style ``reviewCB`` and/or ``summaryCB`` implemented, these will still work, however there could be more labels updated than anticipated. - - More detailed information is available in :bb:status:`GerritStatusPush` section. - -* Buildbot now supports plugins. - They allow Buildbot to be extended by using components distributed independently from the main code. - They also provide for a unified way to access all components. - When previously the following construction was used:: - - from buildbot.kind.other.bits import ComponentClass - - ... ComponentClass ... - - the following construction achieves the same result:: - - from buildbot.plugins import kind - - ... kind.ComponentClass ... - - Kinds of components that are available this way are described in :doc:`../manual/plugins`. - - .. note:: - - While the components can be still directly imported as ``buildbot.kind.other.bits``, this might not be the case after Buildbot v1.0 is released. - -* :bb:chsrc:`GitPoller` now supports detecting new branches - -* :bb:step:`MasterShellCommand` now renders the ``path`` argument. - -* :class:`~buildbot.process.buildstep.ShellMixin`: the ``workdir`` can now be overridden in the call to ``makeRemoteShellCommand``. - -* GitHub status target now allows to specify a different base URL for the API (usefule for GitHub enterprise installations). - This feature requires `txgithub` of version 0.2.0 or better. - -* GitHub change hook now supports payload validation using shared secret, see :ref:`GitHub-hook` for details. - -* Added StashStatusPush status hook for Atlassian Stash - -* Builders can now have multiple "tags" associated with them. Tags can be used in various status classes as filters (eg, on the waterfall page). - -* :bb:status:`MailNotifier` no longer forces SSL 3.0 when ``useTls`` is true. - -* GitHub change hook now supports function as codebase argument. - -* GitHub change hook now supports pull_request events. - -* :class:`~buildbot.process.buildstep.Trigger`: the ``getSchedulersAndProperties`` customization method has been backported from Nine. - This provides a way to dynamically specify which schedulers (and the properties for that scheduler) to trigger at runtime. - Fixes ~~~~~ -* GitHub change hook now correctly responds to ping events. -* ``buildbot.steps.http`` steps now correctly have ``url`` parameter renderable -* :bb:step:`MasterShellCommand` now correctly logs the working directory where it was run. -* With Git(), force the updating submodules to ensure local changes by the build are overwitten. - This both ensures more consistent builds and avoids errors when updating submodules. -* With Git(), make sure 'git submodule sync' is called before 'git submodule update' to update - stale remote urls (:bb:bug:`2155`). - Deprecations, Removals, and Non-Compatible Changes ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -* The builder parameter "category" is deprecated and is replaced by a parameter called "tags". - Changes for Developers ~~~~~~~~~~~~~~~~~~~~~~ -* :class:`~buildbot.process.buildstep.Trigger`: ``createTriggerProperties`` now takes one argument (the properties to generate). - -* :class:`~buildbot.process.buildstep.Trigger`: ``getSchedulers`` method is no longer used and was removed. - Slave ----- @@ -136,7 +42,7 @@ For a more detailed description of the changes made in this version, see the git .. code-block:: bash - git log v0.8.10..eight + git log v0.8.10..0.8.11 Older Versions -------------- @@ -147,6 +53,7 @@ Newer versions are also available here: .. toctree:: :maxdepth: 1 + 0.8.11 0.8.10 0.8.9 0.8.8