Skip to content

colstrom/concourse-github-status

Repository files navigation

GitHub Status

Overview

Create and update GitHub statuses from Concourse.

Usage

Add the resource to your pipeline’s resource_types (requires Concourse 0.74.0+)

resource_types:
  - name: github-status
    type: docker-image
    source:
      repository: resource/github-status

Source Configuration

NameRequiredDescription
repoYesThe GitHub repository in user/repo format
access_tokenYesThe access token to use with the GitHub API

Behaviour

out Update the status for a commit

Parameters

To set a single status for the current commit of the repository specify these parameters:

NameRequiredDefaultDescription
pathYesRelative path to the repository
stateYesOne of pending, success, or failure
contextNoconcourseThe context for the status being updated
descriptionNoA description of the context.
target_urlNobuild URLURL or file containing URL for status target_url

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:

NameRequiredDefaultDescription
pathYesRelative path to the repository
statusesYesArray of status objects

Each of the status objects supports the following parameters:

NameRequiredDefaultDescription
stateYesOne of pending, success, or failure
contextNoconcourseThe context for the status being updated
descriptionNoA description of the context.
target_urlNobuild URLURL or file containing URL for status target_url

check Get a list of available statuses

Parameters

  • None

in Fetch a status

Parameters

Fetches the state of context for the current commit of the repository at path, and write it to {context}.state

NameRequiredDefaultDescription
pathYesRelative path to the repository
contextNoconcourseThe context for the status being updated

License

concourse-github-status is available under the MIT License. See LICENSE.txt for the full text.

Contributors

About

Create and update GitHub statuses from Concourse.

Resources

License

Stars

Watchers

Forks

Packages

No packages published