From 29f1556a923fe855b24b4a740aa66c48a2c22c60 Mon Sep 17 00:00:00 2001 From: Christophe Chaudier Date: Wed, 27 Nov 2024 15:32:56 +0100 Subject: [PATCH] --wip-- [skip ci] --- README-fr.md | 62 +++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 61 insertions(+), 1 deletion(-) diff --git a/README-fr.md b/README-fr.md index 50af5d9..ef1dcb9 100644 --- a/README-fr.md +++ b/README-fr.md @@ -126,7 +126,7 @@ Le nom de la variable qui déclenche un test est `MGCI_TEST_`. Exemple : - `MGCI_TEST_CACHE` -## Structure d'un job +### Structure d'un job Voici la structure type d'un job : @@ -141,6 +141,66 @@ fonction: - if: $MGCI_TEST_FONCTION == "true" ``` +### Organisation du dépôt + +``` +mgci/ +├── artifacts/ # Fichiers générés pour les tests +├── bin/ # Scripts shell utilitaires +│ └── test_runners_tags.sh # Script de test des tags des runners +├── includes-if/ # Configuration des tags des runners par fonctionnalité +│ └── tags/ # Un fichier par fonctionnalité testée +│ ├── api.yml +│ ├── cache.yml +│ └── ... +├── src/ # Sources pour les tests +│ └── index.html.tpl # Template pour le test des GitLab Pages +├── templates/ # Jobs de test GitLab CI +│ ├── bases/ # Templates de jobs de base réutilisables +│ │ ├── .purge.yml # Configuration de base pour les jobs de purge +│ │ └── variables.yml # Variables communes +│ ├── api.yml # Un fichier par fonctionnalité testée +│ ├── cache.yml +│ ├── docker.yml +│ ├── info.yml +│ └── ... +├── .gitignore +├── .gitlab-ci.yml # Configuration CI principale +├── .gitlab-ci.local.yml # Configuration CI pour le développement +├── README.md # Documentation en anglais +└── README-fr.md # Documentation en français +``` + +### `/artifacts` +Contient les fichiers générés pendant les tests. Ces fichiers sont temporaires et ne doivent pas être versionnés. + +### `/bin` +Scripts shell utilisés par les jobs de test. Ces scripts sont principalement des utilitaires pour vérifier le bon fonctionnement des fonctionnalités GitLab. + +### `/includes-if` +Configuration des tags des runners pour chaque fonctionnalité testée. Cette séparation permet une meilleure organisation et maintenance des configurations des runners. + +### `/templates` +Cœur du projet, contient tous les jobs de test GitLab CI. Chaque fichier correspond à une fonctionnalité spécifique à tester. + +#### `/templates/bases` +Templates de base réutilisables par les autres jobs, comme la configuration de purge et les variables communes. + +### `/test` +Contient les fichiers nécessaires aux tests, comme les packages NPM de test. + +## Fichiers Principaux + +- `.gitlab-ci.yml` : Point d'entrée de la configuration CI +- `.gitlab-ci.local.yml` : Configuration pour le développement local +- `README.md` et `README-fr.md` : Documentation du projet en anglais et français + +## Convention de Nommage + +- Les fichiers de test suivent le format : `.yml` +- Les fichiers de configuration des tags suivent le format : `_job_tags.yml` +- Les variables d'environnement commencent toutes par `MGCI_` + ## How-to ### Comment exécuter les jobs de test sur un runner spécifique ? -- GitLab