Gitlab integration
Gitlab integration provides a two-way integration between xltrail and Gitlab (gitlab.com or your own Gitlab server). This document outlines the steps to configure a Gitlab integration, enabling xltrail to post comments on merge requests.
Comments are generated on opening and updating merge requests. Comments provide a summary of added, deleted and modified workbooks as well as backlinks to xltrail workbook comparisons, allowing users to review and compare workbook changes directly.
The integration provides direct links to workbook comparisons, facilitating easier review and collaboration on Excel workbooks.
Note: xltrail currently supports merge request events only. We are working on supporting more Gitlab events. We will also be providing integration with other Git servers (Github, Bitbucket and Gitea) shortly.
Set up a Gitlab integration
To set up Gitlab integration in xltrail, follow these steps:
In xltrail
Make sure you have a Group API Key (Settings > Integration > API Key > Group API Key)
- If you do not have a Group API Key yet, click the "Generate new Group API Key" button
- Navigate to to Settings > Integrations > Add an integration > GitLab > Configure
- Enter your Gitlab Server Url and your Project or Personal Gitlab Access Token
- Click Test to verify Url and Access Token
- Click save
- xltrail can now send messages to Gitlab
Leave this page open and make note of the Gitlab Webhook details at the top
In Gitlab: Configure a webhook for your repository
Navigate to your Gitlab repository
- Click on Settings > Webhooks.
- Add a New Webhook:
- Click on Add new webhook.
- Enter the xltrail Webhook URL and Secret Token (see step 1, last point)
- Select Events: Tick the checkbox for Merge request events (or everything)
- Save the Webhook
- Gitlab can now send a message to xltrail when a merge request occurs.