What is a update GitHub Status Build Event Handler?
The 'Update Github status Build Event handler' is an event handler attached to a configuration which interacts with the Github Status API. This feature allows ContinuaCI to mark commits within a GitHub repository with a success, failure, error, or pending state. These status' can is then be reflected in any pull requests involving those commits.
Example use case
This event handler works fantastically as a pre-step within a pull request pipeline. ContinuaCI can be configured to automatically pull the request, build it, test it, and report back its status.
How to create an update GitHub Status Build Event Handler
- Navigate to the events tab within the desired Build Configuration
- Click the 'Create' link within the 'Build Event Handlers' section
- Enter the name of the event handler (in this case 'update github status')
- Enter the sequence in which you wish this event handler to be run. In our case this is the first event handler so we will leave the default of 1
- From the type dropdown select 'Update GitHub Status'
- Select 'Update GitHub Status' from the top tabs
- Enter the GitHub API URL,
- Enter your GitHub username / password. Please note that passwords should not contain any of the following characters: !:@
- Enter the name of your ContinuaCI repositories that you wish to consider when updating status (these can be found you the 'repositories' page).
Statuses can also include an optional description and target_url, and we highly recommend providing them as they make statuses much more useful in the GitHub UI.
As an example, one common use is for continuous integration services to mark commits as passing or failing builds using Status. The target_url would be the full URL to the build output, and the description would be the high level summary of what happened with the build.