[Collapse]Collaborator 10
 [Expand]General Information/viewarticle/80040/
 [Expand]Getting Started/viewarticle/80359/
 [Expand]Collaborator Server/viewarticle/80060/
 [Expand]Web Client/viewarticle/80107/
 [Expand]Desktop Clients/viewarticle/80151/
 [Expand]Version Control Integration/viewarticle/80048/
 [Collapse]External Integrations/viewarticle/80340/
  [Expand]Creating Custom Reports/viewarticle/80367/
   Bug-Tracking Integration/viewarticle/80405/
  [Expand]JIRA Integration/viewarticle/80130/
  [Expand]GitHub Integration/viewarticle/80343/
  [Expand]Bitbucket Integration/viewarticle/91115/
  [Expand]Web Services/viewarticle/80412/
 [Expand]Techniques & Best Practices/viewarticle/80403/
Updated: 12/23/2016 Applies To: Collaborator 10 Rating: GoodGoodGoodGoodGood 1 vote(s) Click to rate: PoorNot badAverageGoodExcellent

External Integrations

Top |Previous |Next

GitHub Integration

Collaborator provides support for GitHub and GitHub Enterprise, giving you the possibility to easily integrate these two products into your work processes. The integration saves the time and efforts needed to synchronize your commits on GitHub and Collaborator reviews.

How the Integration Works

Collaborator tracks changes at pre-defined GitHub repository and automatically creates reviews in Collaborator upon:

o pull requests in one or several specified branches of the repository,
o pushes to one or several specified branches of the repository. (The latter can be suppressed via the "Ignore pushes for branches" setting.)


On the Collaborator server, the review is assigned to the user who has associated username filled in the Remote Accounts tab of their settings panel. The Review Materials section will hold the files that were modified on the GitHub server.


Besides, the integration updates data in a previously created reviews, when:

o further commits are made in a branch which initiated a pull request,
o a commit was made that resolves file merge conflict.

When a review is completed, the integration may automatically merge or close the appropriate pull request. When a review is cancelled, deleted or rejected, the integration may automatically close pull request. Additionally it may automatically delete the corresponding feature branch upon closing or merging a pull request. This behaviour can be adjusted via GitHub integration options.

If review was completed and pull request being reopened - review will be reopened.

If review was cancelled/deleted/rejected and pull request being reopened - new review will be created.


To use the integration features, you need to obtain a personal access token on GitHub and configure certain settings on the Collaborator server. Read Configuring GitHub Integration for detailed instructions.

Technical Details

When a review is created, the integration uploads a copy of files that were modified on the GitHub server. That is, Collaborator does not depend on commit IDs or any other references to modified files, since it gets the files itself.
Keep this information in mind when rebasing a pull request. Collaborator does not track commit IDs and does not pull the source when needed. If you rebase in such a way that remote branch can be fast-forwarded then no problems are to expect. If you use "git push --force" we cannot guarantee flawless operation. Also, it might be a problem with "comments" in chat.
Integration creates reviews on any pull requests - no matter whether it came from the same repository of from forked repository. Assuming that User Remote Accounts are specified for the owner of forked repository.
When a pull requests causes file conflict, the integration acts as follows. Once a file conflict could be resolved automatically, the merge commit will not be added to the review. If a file conflict was resolved manually (that is, if some files have been changed to complete the merge), then GitHub integration will update the review with the changes from the resolving commit.

Known Issues

Due to limitations of the GitHub API, it is not presently possible to sync over review materials larger than 1MB (for example, large image or document files); to be clear this applies to individual files of greater than 1MB size.
Reviews created on pull requests from forked repositories do not update their state upon further updates of corresponding pull request.

© 2020 SmartBear Software. All rights reserved.
Email Send feedback on this document