Aller au contenu principal

Déploiement sur GitLab

Docusaurus propose une intégration de déploiement automatique avec GitHub. Cependant, si vous préférez déployer sur GitLab ou encore que vous avez besoin des fonctionnalités de pages privées, il vous faudra utiliser GitLab.

Prérequis

Ce guide s'appuie sur le fait que vous avez un site Docusaurus fonctionnel et qu'il est sur un repo GitLab.

  1. À la racine de votre projet, créez un fichier .gitlab-ci.yml pour l'intégration continue GitLab.
  2. Dans le fichier, mettez-y les configurations de déploiement suivantes
.gitlab-ci.yml
image: node:latest

# allow caching for faster deployment
cache:
  paths:
    - node_modules/
    - public/
    - .cache/

pages:
  stage: deploy
  script:
    - yarn install
    - yarn build:gitlab
  artifacts:
      paths:
        - public
  only:
    - main
  1. Dans le fichier package.json, ajoutez la ligne suivante sous scripts
...
"build": "docusaurus build",
"build:gitlab": "docusaurus build --out-dir public",
"swizzle": "docusaurus swizzle",
...
  1. Poussez votre code à l'aide d'un push

Statut du déploiement​

Pour voir le statut du déploiement (CI/CD), vous pouvez aller dans la section Build -> Pipelines

Imgur

Accéder au site​

Pour obtenir l'URL de votre site et y accéder, allez à Deploy -> Pages.

Imgur

Rendre le site privé​

Pour rendre le site privé:

  1. Settings
  2. General
  3. Visibility, project features, permissions
  4. Changez l'option Pages à Only Project Members Imgur

De cette façon, seulement les membres du projet pourront voir la page.