Conteneurisation Docker Doxygen

Comment construire votre documentation Doxygen dans une image docker

Définition du job template

.build-documentation script situé dans le fichier build/.documentation-build.yml du projet IUT_INF63/generic-ci.

Job template utilisée pour construire une image docker à partir d'un Doxyfile existant et pousser l'image construite vers le registre GitLab CodeFirst.

Liste des variables du script :

Nom de la variable	Requis	Valeur par défaut	Description
DOXYGEN_FOLDER_PATH	OUI		Chemin du dossier Doxyfile depuis la racine de votre projet (par exemple Documentation/doxygen)
DOC_TYPE	OUI		Indiquez quel type de documentation doit être packagé (utilisez la valeur DOXYGEN).
DESTINATION_REGISTRY_IMAGE_NAME	NON	$CI_REGISTRY_IMAGE	Chemin du registre où votre image sera poussée (par exemple registry.com/mon-projet)
DESTINATION_REGISTRY_IMAGE_VERSION	NON	$CI_COMMIT_REF_SLUG	Version du registre de l'image qui sera poussée
DESTINATION_REGISTRY_PATH	NON	$CI_REGISTRY	URL du registre où l'image sera poussée (utilisée pour l'authentification, par exemple registry.com)
DESTINATION_REGISTRY_USER	NON	$CI_REGISTRY_USER	Nom d'utilisateur du registre (utilisé pour l'authentification)
DESTINATION_REGISTRY_PASSWORD	NON	$CI_REGISTRY_PASSWORD	Mot de passe de l'utilisateur du registre (utilisé pour l'authentification)

.push-documentation-image script situé dans le fichier build/.documentation-build.yml du projet IUT_INF63/generic-ci.

Job template utilisée pour pousser l'image docker vers le registre CodeFirst. Cette job DOIT être liée à une job de configuration (avec le mot-clé `needs`) !

Aucune variable pour ce script.

Exemple

stages: # Définissez au moins une étape qui correspond au stage de votre job
  - 🏗️build
  - 📦push

include:
  - project: 'IUT_INF63/generic-ci' # Référence au projet gitlab contenant les scripts ci génériques
    ref: 'main' # Référence à la branche du projet ci générique gitlab
    file:
      - 'build/.documentation-build.yml' # Nom du fichier à inclure

# Ensuite dans votre .gitlab-ci.yml vous pouvez étendre ces jobs génériques pour construire votre dockerfile en image docker
build-doxygen-documentation:
  extends: .build-documentation # Étendre la job générique
  stage: 🏗️build
  variables:  # Remplissez les variables dans cette section (veuillez vous référer à la documentation ci-dessous pour la liste complète)
    DOXYGEN_FOLDER_PATH: TODO # Chemin du dossier doxygen de votre projet
    DOC_TYPE: DOXYGEN # Spécifiez le type de documentation que vous voulez construire
    DESTINATION_REGISTRY_IMAGE_NAME: TODO # Ici mettez l'adresse du conteneur quand il sera stocké dans le registre
    DESTINATION_REGISTRY_IMAGE_VERSION: TODO # Ici mettez le nom que vous voulez donner à sa version
  allow_failure: true # Autoriser les échecs globalement sur le pipeline (si désactivé vous pourriez ne pas pouvoir déclencher votre job à la création du pipeline si d'autres étapes sont classées avant)
  rules:
    - when: manual # Vous permet de déclencher votre construction manuellement en utilisant le bouton sur l'interface Gitlab

push-doxygen-documentation:
  extends: .push-documentation-image # Étendre la job générique
  stage: 📦push
  needs:
    - build-doxygen-documentation # Configurer la dépendance entre ce job et le précédent

Exemple de job générée

pipeline