README.org in concourse-github-status-0.5.0 vs README.org in concourse-github-status-0.5.7

- old
+ new

@@ -31,19 +31,42 @@ ** ~out~ Update the status for a commit *** Parameters +To set a single status for the current commit of the repository specify these parameters: + |-------------+----------+-----------+--------------------------------------------| | Name | Required | Default | Description | |-------------+----------+-----------+--------------------------------------------| | path | Yes | | Relative path to the repository | | state | Yes | | One of ~pending~, ~success~, or ~failure~ | | context | No | concourse | The ~context~ for the status being updated | | description | No | | A description of the context. | |-------------+----------+-----------+--------------------------------------------| +It is also possible to set multiple statuses at the same time. This is useful for adding multiple ~pending~ statuses +initially which will be updated by later jobs to the corresponding state, for example. +This can be done by specifying a ~statuses~ array: + +|-------------+----------+-----------+--------------------------------------------| +| Name | Required | Default | Description | +|-------------+----------+-----------+--------------------------------------------| +| path | Yes | | Relative path to the repository | +| statuses | Yes | | Array of status objects | +|-------------+----------+-----------+--------------------------------------------| + +Each of the status objects supports the following parameters: + +|-------------+----------+-----------+--------------------------------------------| +| Name | Required | Default | Description | +|-------------+----------+-----------+--------------------------------------------| +| state | Yes | | One of ~pending~, ~success~, or ~failure~ | +| context | No | concourse | The ~context~ for the status being updated | +| description | No | | A description of the context. | +|-------------+----------+-----------+--------------------------------------------| + ** ~check~ Get a list of available statuses *** Parameters - None @@ -62,10 +85,11 @@ | context | No | concourse | The ~context~ for the status being updated | |-------------+----------+-----------+--------------------------------------------| * License -Apache 2.0 License, see ~LICENSE.txt~ for details. + ~concourse-github-status~ is available under the [[https://tldrlegal.com/license/mit-license][MIT License]]. See + ~LICENSE.txt~ for the full text. * Contributors - [[https://colstrom.github.io/][Chris Olstrom]] | [[mailto:chris@olstrom.com][e-mail]] | [[https://twitter.com/ChrisOlstrom][Twitter]]