cogDisplay information about XWiki extensions built through the GitLab CI
TypeXAR
CategoryApplication
Developed by

Ludovic Dubost, Denis Gervalle, Clément Aubin

Active Installs4
Rating
0 Votes
LicenseGNU Lesser General Public License 2.1

Installable with the Extension Manager

Description

Display information about XWiki extensions built through the GitLab CI

This extension is to be used with a setup of automatic CI between GitLab and an XWiki instance using GitLab pipelines.
The code also allows to monitor commits that would be on a GitHub repository that is mirrored in GitLab.

The macro allows to display the status of the extensions installed in the XWiki instance compared to the commits. It allows to display the version of the extension installed, the link to the last commit in the module and if this commit is actually installed in the wiki.

gitlabcistatus.png

The macro is:

{{gitlabcistatus /}}

The extensions to monitor are configured in the administration. The field to provide are:

  • extension id: <group>:<module>
  • server URL: GitLab or GitHub URL of the instance https://<servername>/
  • projectId or Name: for GitLab this should be a number (the project Id is displayed on the home page of the project). For GitHub it should be the <organization>/<project path>
  • token or authentication: for GitLab it is a project or user token. For GitHub it a <clientid>:<clientsecret> set in the organization settings
  • pipeline URL: this is the link to access the pipeline on GitLab

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