cogProvide reporting macros for GitLab
TypeXAR
CategoryApplication
Developed by

Ludovic Dubost, Denis Gervalle, Clément Aubin

Active Installs5
Rating
0 Votes
LicenseGNU Lesser General Public License 2.1

Installable with the Extension Manager

Description

Provide reporting macros for GitLab allowing to display GitLab issues from a project.

Administration

In the Administration section, it is possible to configure GitLab instances including authentication parameters using GitLab tokens. If the instance data is public the token can be left empty. Each instance will be identified by an "id" which can then be used in the macros parameters.

gitlabmacroadmin.png

Usage

The following parameters are available

Instance to use (id)

This should correspond to the id set in the administration panel

Project Id (projectId)

Project ID to search for issues in. The project Id is a number displayed on the GitLab project home page

Query (content of the macro)

A query (or filter) can be used to find the relevant issues. The filters are on each line.

param=value

Display Type

Multiple display modes are possible (type parameter):

  • default: displays only a link to the issue(s) and striking the number if the issue is clossed
  • list: displays the issue(s) as a list with the title of the issue
  • table: displays the issue(s) as a table with the title of the issue
  • report: displays the issue(s) as a report with the title of the issue and also the commits performed and files associated to the commits

Here are some examples:

gitlabmacro1.png

gitlabmacro2.png

gitlabmacro3.png

Prerequisites & Installation Instructions

We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager). Note that installing Extensions when being offline is currently not supported and you'd need to use some complex manual method.

You can also use the following manual method, which is useful if this extension cannot be installed with the Extension Manager or if you're using an old version of XWiki that doesn't have the Extension Manager:

  1. Log in the wiki with a user having Administration rights
  2. Go to the Administration page and select the Import category
  3. Follow the on-screen instructions to upload the downloaded XAR
  4. Click on the uploaded XAR and follow the instructions
  5. You'll also need to install all dependent Extensions that are not already installed in your wiki
Tags:
    

Get Connected