Skip to content
Torsten Juergeleit edited this page May 30, 2021 · 4 revisions

This plugin provides an easy way to add links for GitLab items in Confluence pages. Just paste a GitLab link in Confluence's WYSIWIG editor and the link gets rendered with additional information retrieved via GitLab's REST API:

Sample

The following types of GitLab links are supported:

  • Projects
  • Commits
  • Tags
  • Issues
  • Merge Requests
  • Milestones
  • Releases
  • Files

If the Confluence user has no permission to access the GitLab resources or the plugin's requirements are not met then simple GitLab links are rendered instead:

Simple GitLab Links

Requirements

The plugin uses the username of the currently authenticated Confluence user to access GitLab's REST API in sudo mode. So for rendering GitLab links with additional data provided by the GitLab server the following requirements need to be met:

  • The users have the same username in Confluence and GitLab.
  • A personal access token - with sudo permission - from a GitLab system administrator is required.

If these requirements are not met then simple GitLab links (without the information provided by the GitLab Server) are rendered.

Installation

Open Confluence's plugin manager and upload the jar from the latest release of this plugin.

Configuration

Open Confluence's Administration Console and select the item GitLab Links Configuration from the left sidebar menu. Here the GitLab server URL and a personal access token (with sudo permission) from a GitLab system administrator are specified.

Config

If the personal access token is omitted then simple GitLab links (without the information provided by the GitLab Server) are rendered.

Clone this wiki locally