Skip to content

Commit

Permalink
Add manual entry for addition of context to GitHubStatus
Browse files Browse the repository at this point in the history
  • Loading branch information
IgnoredAmbience committed Jun 15, 2015
1 parent fde40f1 commit 83c1a5d
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions master/docs/manual/cfg-statustargets.rst
Expand Up @@ -763,10 +763,12 @@ GitHubStatus
repoOwner = Interpolate("%(prop:github_repo_owner)s")
repoName = Interpolate("%(prop:github_repo_name)s")
sha = Interpolate("%(src::revision)s")
context = Interpolate("buildbot/%(prop:buildername)s")
gs = status.GitHubStatus(token='githubAPIToken',
repoOwner=repoOwner,
repoName=repoName,
sha=sha,
context=context,
startDescription='Build started.',
endDescription='Build done.')
buildbot_bbtools = util.BuilderConfig(
Expand Down Expand Up @@ -797,6 +799,9 @@ By default `sha` is defined as: `%(src::revision)s`.

In case any of `repoOwner`, `repoName` or `sha` returns `None`, `False` or empty string, the plugin will skip sending the status.

The `context` argument is passed to GitHub to differentiate between statuses. A static string can be passed or :class:`Interpolate` for dynamic substitution.
The default context is `buildbot/%(prop:buildername)s`.

You can define custom start and end build messages using the `startDescription` and `endDescription` optional interpolation arguments.

Starting with Buildbot version 0.8.11, :class:`GitHubStatus` supports additional parameter -- ``baseURL`` -- that allows to specify a different API base endpoint.
Expand Down

0 comments on commit 83c1a5d

Please sign in to comment.