Upsource 3.5 Help

CI server integration

On this page:

Integration with a CI server (Continuous Integration server) allows Upsource to receive and display build statuses on a commit for a particular project.

When someone makes a commit and a build system runs the build, its status is displayed in the revision list, next to the commit. Since a single commit can sometimes initiate multiple builds, the commit can have more than one build status:

/help/img/upsource/3.5/CI_build_status_rev_list.png

Receiving build statuses from TeamCity

Integrating with a TeamCity CI server is provided via a Commit Status Publisher plugin which comes bundled with the TeamCity version 9.1.7 and newer. Configuring it to work with Upsource is easy and is done on the TeamCity side.

To integrate with TeamCity

  1. Make sure you have administrator access rights to the project in TeamCity.

  2. Go to Settings | Build features | Add build feature.

  3. Choose Commit Status Publisher from the drop-down list.

  4. Specify the following information:

    • Publisher: JetBrains Upsource
    • Upsource URL: the URL of your Upsource server
    • Upsource project ID: the ID of your Upsource project
    • Username, Password: administrator credentials of the Upsource project
  5. Save your settings.

For more information refer to the TeamCity documentation

Receiving build statuses from other CI servers

Upsource comes with a Build Status Endpoint that is open to receive data as JSON payload at http[s]://your-upsource-server/~buildStatus/.

The POST request should include the following header: Content-Type: application/json; charset=UTF-8

The POST request body should include the following fields:

ParameterRequiredDescription
"key"YesBuild key - a unique build identifier (e.g. PROJECT-VERSION-1234)
"state"Yes

Indication of the build status:

  • in_progress: a build for the commit is not yet complete

  • failed: a build for the commit failed

  • success: a build for the commit completed successfully

"url"YesBuild URL
"name"NoBuild name (usually the same as Build key)
"description"NoBuild details (e.g. "15 tests out of 800 are failing")
"project-id"YesProject ID in Upsource
"commit-id" or ["commit-id", "commit-id", "commit-id"]YesCommit ID or a JSON array of commit IDs
Last modified: 1 December 2016