GitLab Assistant allows you to get real-time development updates in Lark, making it easier to track, manage and communicate your development process.
I. Context
- 1. About GitLab
GitLab is a software development platform based on Git. For more details, please refer to the official documents of GitLab.
- 2. About GitLab Assistant
GitLab Assistant enables you to do the following without leaving Lark:
- •Receive real-time updates of GitLab-related projects including comments, issue events, and merge request events by adding GitLab Assistant to group chats
- •Bind your GitLab account with GitLab Assistant to quickly view your pull request and issues lists on Lark mobile, enter detail pages and comment
II. Procedure
- 1. Configure GitLab Assistant bot in groups
1.1 Open the relevant group chat in Lark desktop, add GitLab Assistant bot to the group. (For details, see Bot | Use bots in groups)
1.2 In the group
@GitLab Assistant and send @GitLab Assistant get_webhook to obtain the webhook address of the group.The group admin will receive the webhook address from the bot via private chat. If the group already has a webhook address, the existing address will be sent. Please contact the admin to obtain the address if you aren't the admin.
Note:
You can also send the following commands to the GitLab Assistant bot:
@GitLab Assistant help: Send this command in group chats or private chat with the bot to see capabilities provided by the bot@GitLab Assistant reset_webhook [Only group owners can operate]: Reset the webhook address of group chats. The reset address will be sent to the group admin via private chat.1.3 Enter relevant project in GitLab, click Settings > Webhooks. Configure the webhook address (URL) and check related triggers.
Note: Currently, the GitLab Assistant only supports notifications of Comments, Issue events, and Merge request events.
1.4 Test whether the configuration is successful. Trigger any events you have checked in GitLab. If you receive a notification message pushed by GitLab Assistant bot in the corresponding group chat in Lark, the configuration is successful.
Now, you and your project members can receive project updates in real time in Lark group chats! Click Detail on the card to open your GitLab and view details on desktop.
Note: If you want to click the Detail button on mobile phone to browse project details, please continue to read and complete the mobile gadget configuration of GitLab Assistant.
- 2.Configure and use the mobile gadget
GitLab Assistant also provides the mobile gadget feature. Binding your GitLab account with GitLab Assistant, you can quickly view your pull request and issues lists on Lark mobile, enter detail pages and add comments directly.
2.1 Prerequisites
Your Lark tenant admin must configure the internal GitLab address for the company in GitLab Assistant admin. The steps are as follows:
- •Tenant admin enters Lark Admin > Workplace > Apps List > GitLab Assistant > Open Manager Homepage
- •Click Edit to configure the system address. If you are using the SaaS version of GitLab, you only need to enter https://GitLab.com. If it is a privatized deployment, enter the domain name of the privatized deployment.
Note: If you want to test whether the above address is entered correctly, you can enter it in browser and add the suffix
/api/v4/projects (for example: https://gitlab.com/api/v4/projects) to check the page can be opened correctly.2.2 Use the mobile gadget
After the admin completes the above configuration, you can log in and use GitLab gadget on mobile through the following steps.
2.2.1 Get GitLab access token
- •Go to the GitLab homepage used in the company and click Settings
- •Go to Access Tokens, name your token, check the Scopes of webhook, then click Create personal access token
- •Copy your new personal access token
2.2.2 Go back to Lark, bind your GitLab account with GitLab Connector
- •Method 1: Enter the private chat with GitLab Assistant bot, send the following command to bind:
@GitLab Assistant set_access_token {username} {access_token} Note: {username} is the email prefix of your GitLab account. {access_token} is the access token obtained in GitLab in the previous step.
- •Method 2: Search and open GitLab Assistant gadget on Lark mobile, paste your access token on the login page, and click Binding
2.2.3 Now, you can view details of GitLab update messages on Lark mobile
When receiving message cards of projects from GitLab Assistant in group chats, you can click Detail to enter the GitLab Assistant gadget to view details of pull request or issues, and make comments.
2.2.4 You can also view the pull request and issues lists of all projects you care in GitLab Assistant gadget
In GitLab Assistant Kanban, Pull Request and Issues tabs show respectively the pull request and issues list of the projects you are concerned about. You can click on a certain project to view details and send comments.
To make a project appear in the homepage list of the gadget, first find any notification card related to the project in the relevant group chat, click Detail to open the details page in the mobile gadget. Then you can view the latest pull request and issues lists of the project in the gadget.
Click Me in the bottom navigation bar to enter the personal settings page. You can view personal information or log out of the personal account at any time.