Docusaurus

Job permettant de compiler une doc Docusaurus et de la publier sur GitLab Pages.

Ce job n'est lancé que lors d'un push sur la branche main qui modifie un fichier du dossier DOCUSAURUS_FOLDER.

Il lance npm ci puis npm run build, et place le résultat dans public/, le dossier que GitLab Pages publie. Pages doit être activé sur l'instance GitLab : sans lui, le job réussit mais rien n'est publié.

Inclusion de docusaurus dans un projet

Utilisation

variables:
  CI_TEMPLATE_VERSION: &CI_TEMPLATE_VERSION main
  DOCUSAURUS_FOLDER: 'docs'

include:
  - project: kgaut/gitlab-ci-templates
    ref: *CI_TEMPLATE_VERSION
    file:
      - '/templates/generic/stages-variables-extends.yml'
      - '/templates/generic/docusaurus.yml'

Variables nécessaires

Nom de la variable	Contenu	Exemple	Remarque
DOCUSAURUS_FOLDER	Dossier contenant la documentation	docs	par défaut à docs

Liste des jobs

pages

Compilation de la documentation Docusaurus (stage QA). GitLab la déploie ensuite sur Pages, si Pages est activé sur l'instance.