1Release Notes for Buildbot 0.8.11
2=================================
3
4..
5    Any change that adds a feature or fixes a bug should have an entry here.
6    Most simply need an additional bulleted list item, but more significant
7    changes can be given a subsection of their own.
8
9The following are the release notes for Buildbot 0.8.11.
10This version was released on the 20th of April, 2015.
11
12Master
13------
14
15Requirements:
16
17* Buildbot works python-dateutil >= 1.5
18
19Features
20~~~~~~~~
21
22* GitHub change hook now supports application/json format.
23
24* Buildbot is now compatible with Gerrit v2.6 and higher.
25
26  To make this happen, the return result of ``reviewCB`` and ``summaryCB`` callback has changed from
27
28  .. code-block:: python
29
30     (message, verified, review)
31
32  to
33
34  .. code-block:: python
35
36     {'message': message,
37      'labels': {'label-name': value,
38                ...
39                }
40     }
41
42  The implications are:
43
44  * there are some differences in behaviour: only those labels that were provided will be updated
45  * Gerrit server must be able to provide a version, if it can't the ``GerritStatusPush`` will not work
46
47  .. note::
48
49     If you have an old style ``reviewCB`` and/or ``summaryCB`` implemented, these will still work, however there could be more labels updated than anticipated.
50
51  More detailed information is available in ``GerritStatusPush`` section.
52
53* Buildbot now supports plugins.
54  They allow Buildbot to be extended by using components distributed independently from the main code.
55  They also provide for a unified way to access all components.
56  When previously the following construction was used::
57
58      from buildbot.kind.other.bits import ComponentClass
59
60      ... ComponentClass ...
61
62  the following construction achieves the same result::
63
64      from buildbot.plugins import kind
65
66      ... kind.ComponentClass ...
67
68  Kinds of components that are available this way are described in :doc:`../manual/plugins`.
69
70  .. note::
71
72     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.
73
74* :bb:chsrc:`GitPoller` now supports detecting new branches
75
76* :bb:step:`MasterShellCommand` now renders the ``path`` argument.
77
78* :class:`~buildbot.process.buildstep.ShellMixin`: the ``workdir`` can now be overridden in the call to ``makeRemoteShellCommand``.
79
80* GitHub status target now allows to specify a different base URL for the API (usefule for GitHub enterprise installations).
81  This feature requires `txgithub` of version 0.2.0 or better.
82
83* GitHub change hook now supports payload validation using shared secret, see the GitHub hook documentation for details.
84
85* Added StashStatusPush status hook for Atlassian Stash
86
87* Builders can now have multiple "tags" associated with them. Tags can be used in various status classes as filters (eg, on the waterfall page).
88
89* ``MailNotifier`` no longer forces SSL 3.0 when ``useTls`` is true.
90
91* GitHub change hook now supports function as codebase argument.
92
93* GitHub change hook now supports pull_request events.
94
95* :class:`~buildbot.process.buildstep.Trigger`: the ``getSchedulersAndProperties`` customization method has been backported from Nine.
96  This provides a way to dynamically specify which schedulers (and the properties for that scheduler) to trigger at runtime.
97
98Fixes
99~~~~~
100
101* GitHub change hook now correctly responds to ping events.
102* ``buildbot.steps.http`` steps now correctly have ``url`` parameter renderable
103* :bb:step:`MasterShellCommand` now correctly logs the working directory where it was run.
104* With Git(), force the updating submodules to ensure local changes by the build are overwritten.
105  This both ensures more consistent builds and avoids errors when updating submodules.
106* With Git(), make sure 'git submodule sync' is called before 'git submodule update' to update
107  stale remote urls (:bug:`2155`).
108
109Deprecations, Removals, and Non-Compatible Changes
110~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
111
112* The builder parameter "category" is deprecated and is replaced by a parameter called "tags".
113
114Changes for Developers
115~~~~~~~~~~~~~~~~~~~~~~
116
117* :class:`~buildbot.process.buildstep.Trigger`: ``createTriggerProperties`` now takes one argument (the properties to generate).
118
119* :class:`~buildbot.process.buildstep.Trigger`: ``getSchedulers`` method is no longer used and was removed.
120
121Slave
122-----
123
124Features
125~~~~~~~~
126
127Fixes
128~~~~~
129
130Deprecations, Removals, and Non-Compatible Changes
131~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
132
133Details
134-------
135
136For a more detailed description of the changes made in this version, see the git log itself:
137
138.. code-block:: bash
139
140   git log v0.8.10..532cf49
141