Gerrit

Gerrit is a free, web-based team code collaboration tool built on top of the Git version control system. It allows merging changes to Git repository when you are done with the code reviews.

Use the SEI Gerrit integration to integrate SEI with Gerrit.

Pre-requisites

You must create HTTP credentials in Gerrit that you will use as an API key when you configure the integration. You can generate a new HTTP credential by selecting 'Generate New Password' under the HTTP credentials section in the Gerrit settings.

For more information, Go to Generating HTTP credentials in Gerrit.

Configuring the integration using cloud

  1. Select Integrations under Settings.

  2. Select Available Integrations, locate the Gerrit integration, and select Install.

  3. Configure and save the integration.

    1. URL: Enter the URL for your Gerrit instance with a slash at the end, such as https://gerrit.example.com/.

    2. User Name: Enter your Gerrit account user name.

    3. API Key: Enter your Gerrit HTTP credentials.

    4. Name: Enter a name for the integration.

    5. Description and Tags are optional.

Configure the integration using satellite

The steps for configuring the integration using satellite is similar to configuring the integration on cloud, with the exception of using satellite to communicate with the Gerrit server.

Make sure to select the satellite integration checkbox while configuring the integration. Once you save the integration a satellite.yml file will be automatically generated and downloaded to your computer. Update it following the instructions here.

Here’s a sample satellite.yml file:

satellite:
  tenant: foo
  api_key: <sei-api-key>
  url: 'https://testapi1.propelo.ai'
integrations:
  - id: '4687'
    application: gerrit
    url: 'https://www.gerritcodereview.com/'
    username: test-gerrit
    api_key: <gerrit-api-key>

If you encounter any issues during the integration process, go to the Satellite integration Troubleshooting and FAQs.

Last updated