File: cls-build.rst

package info (click to toggle)
buildbot 4.3.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 21,080 kB
  • sloc: python: 174,183; sh: 1,204; makefile: 332; javascript: 119; xml: 16
file content (40 lines) | stat: -rw-r--r-- 1,260 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
Builds
======

.. py:module:: buildbot.process.build

The :py:class:`Build` class represents a running build, with associated steps.

Build
-----

.. py:class:: Build

    .. py:attribute:: buildid

        The ID of this build in the database.

    .. py:method:: getSummaryStatistic(name, summary_fn, initial_value=None)

        :param name: statistic name to summarize
        :param summary_fn: callable with two arguments that will combine two values
        :param initial_value: first value to pass to ``summary_fn``
        :returns: summarized result

        This method summarizes the named step statistic over all steps in which it exists, using ``combination_fn`` and ``initial_value`` to combine multiple results into a single result.
        This translates to a call to Python's ``reduce``::

            return reduce(summary_fn, step_stats_list, initial_value)

    .. py:method:: getUrl()

        :returns: URL as string

        Returns url of the build in the UI.
        Build must be started.
        This is useful for custom steps.

    .. py:attribute:: env

        Initialized from :py:class:`BuilderConfig`'s env by deep copy.
        This attribute is mutable, steps can update it to change the environment of subsequent steps.