/mattermost-plugin-gitlab

GitLab plugin for Mattermost

Primary LanguageGoApache License 2.0Apache-2.0

Mattermost GitLab Plugin

Build Status Code Coverage Release HW

Maintainer: @iomodo Co-Maintainer: @hanzei

A GitLab plugin for Mattermost.

Originally developed by Romain Maneschi.

GitLab Plugin screenshot

Features

  • Daily reminders - the first time you log in to Mattermost each day, get a post letting you know what issues and merge requests need your attention
  • Notifications - get a direct message in Mattermost when someone mentions you, requests your review, comments on or modifies one of your merge requests/issues, or assigns you on GitLab
  • Sidebar buttons - stay up-to-date with how many reviews, unread messages, assignments and open merge requests you have with buttons in the Mattermost sidebar
  • Slash commands - interact with the GitLab plugin using the /gitlab slash command
    • Subscribe to a repository - Use /gitlab subscriptions add to subscribe a Mattermost channel to receive posts for new merge requests and/or issues in a GitLab repository
    • Get to do items - Use /gitlab todo to get an ephemeral message with items to do in GitLab
    • Update settings - Use /gitlab settings to update your settings for the plugin
    • And more! - Run /gitlab help to see what else the slash command can do
  • Supports GitLab On Premise - Works with SaaS and On Premise versions of GitLab

Installation

In Mattermost 5.16 and later, the GitLab plugin is included in the Plugin Marketplace which can be accessed from Main Menu > Plugins Marketplace. You can install the GitLab plugin and then configure it via the Plugin Marketplace "Configure" button.

In Mattermost 5.13 and earlier, follow these steps:

  1. Go to https://github.com/mattermost/mattermost-plugin-gitlab/releases to download the latest release file in zip or tar.gz format.
  2. Upload the file through System Console > Plugins > Management, or manually upload it to the Mattermost server under plugin directory. See documentation for more details.

See Compatibility for supported versions.

Configuration

Step 1: Register an OAuth application in GitLab

  1. Go to https://gitlab.com/profile/applications or https://gitlab.yourdomain.com/profile/applications to register an OAuth app.
  2. Set the following values:
    • Name: Mattermost GitLab Plugin - <your company name>
    • Redirect URI: https://your-mattermost-url.com/plugins/com.github.manland.mattermost-plugin-gitlab/oauth/complete, replacing https://your-mattermost-url.com with your Mattermost URL
  3. Select api and read_user in Scopes
  4. Save the application. Copy the Application ID and Secret fields in the resulting screen.
  5. In Mattermost, go to Plugins Marketplace > GitLab > Configure, and enter the GitLab URL, GitLab OAuth Client ID, and GitLab OAuth Client Secret

Step 2: Configure plugin in Mattermost

  1. Go to System Console > Plugins > GitLab and do the following:
  • Generate a new value for Webhook Secret.
  • Generate a new value for At Rest Encryption Key.
  • (Optional) GitLab Group: Lock the plugin to a single GitLab group by setting this field to the name of your GitLab group.
  • (Optional) Enable Private Repositories: Allow the plugin to receive notifications from private repositories by setting this value to true. When enabled, existing users must reconnect their accounts to gain access to private project. Affected users will be notified by the plugin once private repositories are enabled.
  1. Hit Save.
  2. Go to Plugins Marketplace > GitLab > Configure > Enable Plugin and click Enable to enable the GitLab plugin.

Step 3: Connect your GitLab accounts

Run the /gitlab connect slash command to connect your Mattermost account with GitLab.

Step 4: Subscribe to Projects and Groups

Note for each project you want to receive notifications for or subscribe to, you must create a webhook

Run the subscribe slash command to watch events sent from GitLab.

/gitlab subscriptions add group[/project]

Run the webhook slash command to have GitLab send events to Mattermost.

/gitlab webhook add group[/project]

Compatibility

Mattermost-Plugin-Gitlab Mattermost GitLab
0.3.0 5.10+ 11.2+
0.2.0 5.8+ 11.2+
0.1.0 5.8+ 11.2+

Developing

This plugin contains both a server and web app portion.

Use make dist to build distributions of the plugin that you can upload to a Mattermost server.

Use make check-style to check the style.

Use make deploy to deploy the plugin to your local server. Before running make deploy you need to set a few environment variables:

export MM_SERVICESETTINGS_SITEURL=http://localhost:8065
export MM_ADMIN_USERNAME=admin
export MM_ADMIN_PASSWORD=password

Inspiration

This project is a fork of the mattermost-plugin-github. Thanks to all contributors of it.

Feedback and Feature Requests

Feel free to create a GitHub issue or join the GitLab Plugin channel on our community Mattermost instance to discuss.