Commit 3a99d02c authored by admin-cleverage's avatar admin-cleverage
Browse files

Update template README

parent 50c04e3b
Pipeline #2245 failed with stages
in 47 seconds
......@@ -2,6 +2,17 @@
Ce dépôt à pour objectif de proposer des conseils et des templates pour démarrer facilement l'intgration continue sur un projet.
## Avant de démarrer
Si ce n'est pas déjà fait, nous vous invitons à consulter la documentation disponible dans le MAGO et notamment :
* [Une explication de l'interface de la forge](https://forge.grandlyon.com/systemes-dinformation/mago/wikis/02_exigences/02_04_ingenierie-logicielle/Interface-forge-logicielle)
* [La FAQ à destination des gestionnaires de projets](https://forge.grandlyon.com/systemes-dinformation/mago/wikis/02_exigences/02_04_ingenierie-logicielle/faq-forge-logicielle)
* [La section dédiée à l'Intégration Continue](https://forge.grandlyon.com/systemes-dinformation/mago/wikis/02_exigences/02_04_ingenierie-logicielle/02_04_01_ci-cd)
## CI/CD
Ce template utilise les fonctionnalités suivantes de la forge pour vous permettre de faire de l'Intégration Continue :
......@@ -15,6 +26,7 @@ Ce runner est lancé via Docker et nécessite l'utilisation de Docker-in-Docker.
Ce runner n'a que pour objectif de construire vos images.
Si vous souhaitez effectuer des déploiements automatiques via Gitlab, il vous faudra intégrer votre propre runner.
Vous retouverez les informations d'installation et de liaison d'un runner via le menu `Settings > CI / CD` puis déplier la zone `Runners` et suivre les instructions de la partie `Set up a specific Runner manually`.
### Docker
......@@ -29,15 +41,16 @@ Cela est particulièrement utile dans le cas de l'utilisation de la fonctionnali
## SonarQube
Aller sur [SonarQube](https://sonarqube.forge.grandlyon.com) puis créer un projet (de préférence utiliser le nom du dépot GitLab comme nom de projet sur SonarQube).
Allez sur [SonarQube](https://sonarqube.forge.grandlyon.com) puis créez un projet (de préférence utiliser le nom du dépot GitLab comme nom de projet sur SonarQube).
> IMPORTANT ! Bien conserver le token qui est généré à la création du projet, il est nécessaire pour la CI et n'est disponible qu'une seule fois !
### Gitlab
Une fois les informations récupérées :
Dans le projet Gitlab aller dans Setting > CI / CD > Variables
* allez dans le projet Gitlab
* entrez dans le menu `Settings > CI / CD`, dépliez la section `Variables`
* puis ajoutez les variables suivantes :
Puis ajouter les variables suivantes :
- key = SONAR_PROJECT_KEY, value = [clé de projet ajouter dans SonarQube]
- key = SONAR_TOKEN, value = le token généré à la création du projet dans Sonar.
......@@ -58,3 +71,8 @@ Dans le dossier `.gitlab`, vous retrouverez 2 exemples de templates.
Vous pouvez ajouter, modifier ou supprimer autant de templates que vous le souhaitez, tant que l'aborescence est respecté.
Les templates sont à rédiger au format Markdown et doivent porter l'extension `.md`.
Pour plus d'information sur l'utilité des modèles et comment les utiliser :
* [dans le MAGO](https://forge.grandlyon.com/systemes-dinformation/mago/wikis/02_exigences/02_04_ingenierie-logicielle/faq-forge-logicielle#je-veux-d%C3%A9finir-des-mod%C3%A8les-de-tickets)
* [sur Gitlab.com (en)](https://docs.gitlab.com/ce/user/project/description_templates.html#creating-issue-templates)
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment