The Chromium Projects

Search this site

Except as otherwise noted, the content of this page is licensed under a Creative Commons Attribution 2.5 license, and examples are licensed under the BSD License.

Buildbot Annotations

The annotator allows your project to generate buildbot build stages as it runs, simply by emitting special tags to stdout/stderr.
This allows you to capture you build process in a single root level script, run it locally, and have your process branch with the project.

Here are a list of the currently supported annotations:

  @@@BUILD_STEP <stepname>@@@
  Add a new step <stepname>. End the current step, marking with last available
  status.

  @@@STEP_LINK@<label>@<url>@@@
  Add a link with label <label> linking to <url> to the current stage.

  @@@STEP_WARNINGS@@@
  Mark the current step as having warnings (orange).

  @@@STEP_FAILURE@@@
  Mark the current step as having failed (red).

  @@@STEP_EXCEPTION@@@
  Mark the current step as having exceptions (magenta).

  @@@STEP_CLEAR@@@
  Reset the text description of the current step.

  @@@STEP_SUMMARY_CLEAR@@@
  Reset the text summary of the current step.

  @@@STEP_TEXT@<msg>@@@
  Append <msg> to the current step text.

  @@@STEP_SUMMARY_TEXT@<msg>@@@
  Append <msg> to the step summary (appears on top of the waterfall).

  @@@HALT_ON_FAILURE@@@
  Halt if exception or failure steps are encountered (default is not).

  @@@HONOR_ZERO_RETURN_CODE@@@
  Honor the return code being zero (success), even if steps have other results.


Environment Variables passed into annotated steps:

BUILDBOT_BLAMELIST
Names of users who triggered the build %(blamelist:-[])s.
['username1', 'username2']

BUILDBOT_BRANCH
Name of the branch that this was triggered on %(branch:-None)s.

BUILDBOT_BUILDERNAME
Name of the buildbot builder %(buildername:-None)s.

BUILDBOT_BUILDNUMBER
Build number of the current build (unique when combined with BUILDBOT_BUILDERNAME for one master, unless master database is reset) %(buildnumber:-None)s.

BUILDBOT_CLOBBER
Set to '1' if clobber was set on the tryjob or force build check-box was checked %(clobber:+1)s.
Empty otherwise.

BUILDBOT_GOT_REVISION
Current gotten revision to the best of buildbot's knowledge, may be empty %(got_revision:-None)s.

BUILDBOT_REVISION
Current revision to the best of buildbot's knowledge, may be empty %(revision:-None)s.

BUILDBOT_SCHEDULER
Name of the scheduler managing this builder %(scheduler:-None)s.

BUILDBOT_SLAVENAME
The current builder's name, as described in buildbot config %(slavename:-None)s.


 Deprecated annotations:

  @@@BUILD_WARNINGS@@@
  Equivalent to @@@STEP_WARNINGS@@@

  @@@BUILD_FAILED@@@
  Equivalent to @@@STEP_FAILURE@@@

  @@@BUILD_EXCEPTION@@@
  Equivalent to @@@STEP_EXCEPTION@@@

  @@@link@<label>@<url>@@@
  Equivalent to @@@STEP_LINK@<label>@<url>@@@

Comments