This documentation relates to QuickBuild 9.0.x
Select here if you are using a different version

Working with GitHub

Version 7 by Steve Luo
on Aug 27, 2019 07:49.


compared with
Version 8 by Steve Luo
on Aug 27, 2019 07:50.


Key
These lines were removed. This word was removed.
These lines were added. This word was added.

View page history


There are 1 changes. View first change.

 QuickBuild integrates with GitHub via the GitHub repository. This repository has all features of a normal [Git repository|Working with Git], but add the ability to build against pull requests, and update pull request status based on build result.
  
 h2. Build against pull requests
  
 To build against GitHub pull requests, define a GitHub repository like below:
  
 !repository.png!
  
 In repository definition, you may select to build against open, closed, or specified pull requests, and choose to build head, merge, or both of selected build requests like below:
 !pull_requests.png!
 Here _head_ branch of pull request points to tip commit of the pull request, while _merge_ points to merged commit of head commit and tip commit of target branch of the pull request. After defining the Git repository, you should add a checkout step to check it out into the workspace, and add necessary build steps to build against checked out contents.
  
 Upon triggering of configuration using such repository, QuickBuild will first find all matched pull requests at GitHub side and then fire separate build request(s) for each pull request to check changes against that pull request, and build that pull request if necessary. So if there are many matched pull requests, many build requests will be fired. So it is best practice to enable [concurrent build|Build Concurrency and Deadlock] to speed up verification of multiple pull requests.
  
 As demonstrated below, each finished build will display associated pull request as branch information and changes of the build will be calculated against previous build with the same pull request branch.
 !branch.png!
  
 Upon manual triggering of such configuration, all matched pull requests will be built even if they've not being updated, just like what QuickBuild behaves when trigger configurations using normal repositories. However if you schedule the configuration and set build condition to _If changes found in referenced repositories_ (or something similar), QuickBuild will only build against new/updated pull requests.
  
 h2. Update pull request status at GitHub side based on build status
  
 When build against *head branch* of GitHub pull requests, QuickBuild will update pull request status automatically to reflect build status when build is started/finished, as demonstrated below:
 !verifying_pullrequest.png!
 !verified_pullrequest.png!
  
 {note}To make this working, make sure head branch of relevant pull requests are getting built as pull request status reflects head commit status.{note}
  
 h2. GitHub Webhook Integration
  
 QuickBuild can trigger builds via GitHub webhooks since 9.0.
  
 h3. Config GitHub
 To enable the webhook, first you need go to GitHub repository webhook settings page to configure the QuickBuild side related information:
  
 !github-settings.png!
  
 If you want to use some custom parameters, you can add them to your webhook url like below:
  
  [code]
 http://your.quickbuild.com/rest/webhook/github/14?target=android
 [code]
  {{http://your.quickbuild.com/rest/webhook/github/14?target=android}}
  
 Then, later you can use _target_ parameter in your trigger condition.
  
  
 h3. Config QuickBuild
  
 h4. Add anonymous group
 As the webhook is triggered without authentication, anonymous group should be added and it should have the permission to use RESTful API.
  
 h4. Add webhook settings
  
 QuickBuild only allow push event to trigger the builds, other events will be ignored. To add integration at QuickBuild side, please go to configuration settings page and then choose Webhook -> GitHub from right side menu:
  
 !webhooks-menu.png!
  
 Then, you can add the settings:
 * *Trigger User* the user to trigger the build
 * *Webhook Secret* the secret should be the same as what you defined in GitHub
 * *Trigger Condition* the trigger condition in Groovy scripts, when the result is true, build will be triggered, otherwise, the build will not be triggered. You can use variable _delivery_ to access the data from GitHub like _delivery.ref_, _delivery.pusher.name_. See more details on [PushEvent|https://developer.github.com/v3/activity/events/types/#pushevent] and [PullRequestEvent|https://developer.github.com/v3/activity/events/types/#pullrequestevent]. You can also use the parameter specified in webhook URL as aforementioned.
  
 !github-webhook-settings.png!