gitlab-org--gitlab-foss/doc/user/project/integrations/overview.md

10 KiB

stage group info
Create Ecosystem To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments

Integrations (FREE)

Integrations allow you to integrate GitLab with other applications. They are a bit like plugins in that they allow a lot of freedom in adding functionality to GitLab.

Accessing integrations

You can find the available integrations under your project's Settings > Integrations page.

There are more than 20 integrations to integrate with. Click on the one that you want to configure.

Integrations list

Integrations listing

Click on the service links to see further configuration instructions and details.

Service Description Service hooks
Asana Add commit messages as comments to Asana tasks. {dotted-circle} No
Assembla Manage projects. {dotted-circle} No
Atlassian Bamboo CI Run CI/CD pipelines with Atlassian Bamboo. {check-circle} Yes
Bugzilla Use Bugzilla as the issue tracker. {dotted-circle} No
Buildkite Run CI/CD pipelines with Buildkite. {check-circle} Yes
Campfire Connect to chat. {dotted-circle} No
Confluence Workspace Replace the link to the internal wiki with a link to a Confluence Cloud Workspace. {dotted-circle} No
Custom issue tracker Use a custom issue tracker. {dotted-circle} No
Discord Notifications Send notifications about project events to a Discord channel. {dotted-circle} No
Drone CI Run CI/CD pipelines with Drone. {check-circle} Yes
Emails on push Send commits and diff of each push by email. {dotted-circle} No
EWM Use IBM Engineering Workflow Management as the issue tracker. {dotted-circle} No
External wiki Link an external wiki. {dotted-circle} No
Flowdock Send notifications from GitLab to Flowdock flows. {dotted-circle} No
GitHub Obtain statuses for commits and pull requests. {dotted-circle} No
Google Chat Send notifications from your GitLab project to a room in Google Chat. {dotted-circle} No
Irker (IRC gateway) Send IRC messages. {dotted-circle} No
Jenkins Run CI/CD pipelines with Jenkins. {check-circle} Yes
JetBrains TeamCity CI Run CI/CD pipelines with TeamCity. {check-circle} Yes
Jira Use Jira as the issue tracker. {dotted-circle} No
Mattermost notifications Send notifications about project events to Mattermost channels. {dotted-circle} No
Mattermost slash commands Perform common tasks with slash commands. {dotted-circle} No
Microsoft Teams notifications Receive event notifications. {dotted-circle} No
Packagist Update your projects. {check-circle} Yes
Pipelines emails Send the pipeline status to a list of recipients by email. {dotted-circle} No
PivotalTracker Use PivotalTracker as the issue tracker. {dotted-circle} No
Prometheus Monitor application metrics. {dotted-circle} No
Pushover Get real-time notifications on your device. {dotted-circle} No
Redmine Use Redmine as the issue tracker. {dotted-circle} No
Slack application Use Slack's official GitLab application. {dotted-circle} No
Slack notifications Send notifications about project events to Slack. {dotted-circle} No
Slack slash commands Enable slash commands in workspace. {dotted-circle} No
Unify Circuit Receive events notifications. {dotted-circle} No
Webex Teams Receive events notifications. {dotted-circle} No
YouTrack Use YouTrack as the issue tracker. {dotted-circle} No

Push hooks limit

Introduced in GitLab 12.4.

If a single push includes changes to more than three branches or tags, services supported by push_hooks and tag_push_hooks events aren't executed.

The number of branches or tags supported can be changed via push_event_hooks_limit application setting.

Project integration management

Project integration management lets you control integration settings across all projects of an instance. On the project level, administrators you can choose whether to inherit the instance configuration or provide custom settings.

Read more about Project integration management.

Service templates

Service templates were a way to set predefined values for a project integration across all new projects on the instance. They are deprecated and scheduled to be removed in GitLab 14.0.

GitLab recommends you use project integration management instead of service templates. GitLab versions 13.3 and later provide instance-level integrations you can use. instead.

Troubleshooting integrations

Some integrations use service hooks for integration with external applications. To confirm which ones use service hooks, see the integrations listing above. GitLab stores details of service hook requests made within the last 2 days. To view details of the requests, go to that integration's configuration page.

The Recent Deliveries section lists the details of each request made within the last 2 days:

  • HTTP status code (green for 200-299 codes, red for the others, internal error for failed deliveries)
  • Triggered event
  • URL to which the request was sent
  • Elapsed time of the request
  • Relative time in which the request was made

To view more information about the request's execution, click the respective View details link. On the details page, you can see the request headers and body sent and received by GitLab.

To repeat a delivery using the same data, click Resend Request.

Recent deliveries

Uninitialized repositories

Some integrations fail with an error Test Failed. Save Anyway when you attempt to set them up on uninitialized repositories. Some integrations use push data to build the test payload, and this error occurs when no push events exist in the project yet.

To resolve this error, initialize the repository by pushing a test file to the project and set up the integration again.

Contributing to integrations

Because GitLab is open source we can ship with the code and tests for all plugins. This allows the community to keep the plugins up to date so that they always work in newer GitLab versions.

For an overview of what integrations are available, please see the project_services source directory.

Contributions are welcome!