Page History

What is an update GitHub Status Build Event Handler?

The 'Update Github status Status Build Event handlerHandler' is an event handler which interacts with the Github Status API.  This feature allows ContinuaCI to mark commits within a GitHub repository with a success, errorfailure, or pending state.  The status can then be reflected in any pull requests involving those commits.

The event handler is set to automatically respond the following Build Events:

• On Before Stage Start
• On Build Pending Promotion
• On Stage Completed
• On Build Stopping
• On Build Completed
  
  

The Pending status is sent when the On Before Stage Start event is triggered for a specified stage. 

The Success status is sent when the On Stage Completed event is triggered for a specified stage, or optionally when the On Build Pending Promotion event fires - whichever is first.

The Failure status is sent when the On Stage Completed event is triggered for a specified stage or On Build Stopping, On Build Completed events are triggered and the build has failed. 

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.

...

1. Enter the stage timings when this event handler should be run.
   
   
   

   Start Stage 

   The stage timing when for the On Before Stage Start event when the 'Pending Comment' text will be sent 
   

   End Stage 

   The stage timing when the 'Pending Comment' text for the On Stage Completed event when the 'Success Comment' or 'Failure Comment' text will be sent 
   

   Complete on Waiting Promotion

   If any stage is awaiting promotion, send the Success or Failure Comment on the On Build Pending Promotion event

Comments

1. Enter the comments that you wish to send to GitHub
   
   
   

   Pending Comment

   The text of the comment that will be sent when the stage build hits the specified 'On Before Stage Start Stage' timingevent for the specified stage.
   

   Failure Comment

   The text of the comment that will be sent when the stage when build hits the specified 'End On Stage Completed' timingevent for the specified stage, and the build has failed.
   

   Success Comment

   The text of the comment that will be sent when the stage when build hits the specified 'End On Stage Completed' timing, and event for the specified stage, and the build has Succeededsucceeded.
   

Comments

1. Select the build options for this event handler
   
   
   

   Wait for Results

   Should the event handler wait for the result before proceeding. Unchecking this option will run the tagging action in a separate thread.  
   

   Fail Build on Error

   Whether or not to Fail the build if this event handler fails.
   

   Log Build Messages

   Whether or not logs for this event handler will be displayed in the build log.

...