GitLab webhook indexing integration

With webhook indexing integration, there’s no need to enable indexing triggers in the git manager configuration page.

For a step-by-step setup guide, watch the following demonstration videos:

Video Guides

Repository Level

Right click here and open this video in a new window/tab for more viewing options.

Group Level

Right click here and open this video in a new window/tab for more viewing options.

Connect GitLab.com or GitLab CE|EE using the Webhook Indexing integration type to Jira Cloud:

The steps outlined below requires that Git Integration for Jira app is already installed on your Jira Cloud instance. Otherwise, install the Git Integration for Jira app first from the Atlassian Marketplace.

  1. Webhook indexing integration

    1. On your Jira Cloud dashboard, go to AppsGit Integration: Manage Git repositories.

    2. On the integration panel under Limited feature connect, click Webhooks.

    3. On the following screen, click GitLab as your git server type.

    4. Click Connect GitLab under Webhooks indexing column to connect to your git server. The following screen is displayed:

      • Enter a meaningful Display name for the new webhook indexing integration.

    5. Don’t click Finish yet.
      Before clicking Finish, make sure to configure webhook for your git service. Follow the steps below for the webhook setup.

  2. repository level GitLab Repository webhook setup (see full video walkthrough on this page)
    Open a new browser tab and login to your GitLab web portal to setup webhook triggers for the selected repository. Configure a webhook on your git service by performing the following steps:

    1. On your GitLab web portal, open a repository to work on.

    2. Go to Settings.

    3. On the sidebar, click Webhooks. The next screen is displayed.

    4. On the URL box, paste the Webhook URL that you got from the previous section.

    5. On the Secret token box, paste the Secret key that you got from step 4 above.

    6. Set or select which events to trigger for this webhook:

      • Push events – This will send trigger events for commits and branches only. (Recommended)

      • Tags push eventscoming soon This will be supported in the future.

      • Merge request events – This will send trigger events for merge requests event triggers. (Recommended)

    7. Review your webhook setup and we recommend to test your settings. For example, test Push events and Merge request events if it fails or succeeds.

    8. If it returns no errors, click Add webhook to save the webhook configuration.

    9. The webhook configuration is added to the webhooks list.

  3. group level GitLab Group webhook setup (see full video walkthrough on this page)
    Open a new browser tab and login to your GitLab web portal to setup webhook triggers for the selected group. Configure a webhook on your git service by performing the following steps:

    1. On your GitLab web portal, go to Your groups and open a group to work on.

    2. Go to Settings.

    3. On the sidebar, click Webhooks. The next screen is displayed.

    4. On the URL box, paste the Webhook URL that you got from the previous section.

    5. On the Secret token box, paste the Secret key that you got from step 4 above.

    6. Set or select which events to trigger for this webhook:

      1. Push events – This will send trigger events for commits and branches only. (Recommended)

      2. Tags push eventscoming soon This will be supported in the future.

      3. Merge request events – This will send trigger events for merge requests event triggers. (Recommended)

    7. Review your webhook setup and we recommend to test your settings. For example, test Push events and Merge request events if it fails or succeeds.

    8. If it returns no errors, click Add webhook to save the webhook configuration.

    9. The webhook configuration is added to the webhooks list.

  4. After you’re done setting up the webhook with your git service (GitLab), switch to the Jira Cloud browser tab. Click Finish to complete this setup.

If you see any issues with the newly added webhook, verify that the Payload URL and Secret key are set properly. Edit the these settings and try again.

Edit integration settings via Actions on the Manage Git repository page. In here, you will find Webhook URL and Secret key for use with webhook setup with your git service.

Make a commit if you don’t see commits in the Git Commits tab of an associated Jira issue.

For information on this topic, see Linking git commits, associating branches and pull requests to a Jira issue.

Limited features for GitLab webhook indexing integration

The feature table displays the supported git features for the selected git server. For more information, see Feature matrix for Git Integration for Jira Cloud.

Click View supported types below the table to see the currently supported git service types.

Works with git servers behind firewall

The webhooks indexing integration limits the features available. However, networks hosting git do not need to be updated to allow incoming requests as long as outbound requests can be made. See Webhook Indexing explainer for more information.

View commits, branches, pull requests in Jira

Commits, branches, pull requests are visible in the Jira Development Information panel as well as in the Git Commits issue tab and Git Integration side panel of the Jira issue. Jira administrators can regulate access to these displays using the View development tools permission.

View tags in Jira

comming soon

Support for Automation for Jira + Smart Commits

Automation for Jira - the following triggers are supported:

  1. Commit created

  2. Branch created

  3. Pull request created

  4. Pull request declined

  5. Pull request merged

Smart Commits: Atlassian’s Smart Commits are enabled by default. Additional Smart Commit commands are available. See Smart Commits for more information.

Repository Browser

The Repository Browser allows users to view commits in git repositories by branch1. Users can manually link and unlink commits to Jira issues2.

  • Click a git repository on the View all repositories page to start from here.

Create branches and pull requests in Jira

This feature is not supported with webhook indexing integration. For more information, see Feature matrix of Git Integration for Jira Cloud

Support for large number of commits in git pushes

Git servers may truncate how much of the activity is captured in a webhook on large git push events resulting in some git activity. For more information, see Feature matrix of Git Integration for Jira Cloud.

Indexing full repository history

Webhook indexing integration will only show new commit/branch/pull request activity once webhooks are configured on the git server according to this wizard. For more information, see Feature matrix of Git Integration for Jira Cloud.

View source code in Jira

Webhook indexing integration does not have this option as webhooks do not contain source code.

 

Other supported webhook indexing integration articles