/
Badges de projet : Affichage de l'état du déploiement
Les badges de projet sont un moyen simple et efficace de montrer l'état de déploiement actuel de votre projet. Ils fournissent des commentaires en temps réel sur l'état de la compilation, aidant les équipes et les utilisateurs à comprendre rapidement si le dernier déploiement a réussi ou échoué.
Table des matières
- Qu'est-ce qu'un badge de projet?
- Pourquoi utiliser les badges de statut de déploiement?
- Fonctionnement des badges de projet
- Ajout d'un badge d'état de déploiement à votre projet
- Services et formats de badges communs
- Les meilleures pratiques
- Glossaire
Qu'est-ce qu'un badge de projet?
Un badge de projet est un petit indicateur graphique, généralement une image, qui représente visuellement des informations clés sur votre projet. Lorsqu'ils sont utilisés pour le statut de déploiement, les badges affichent souvent des statuts tels que:
- Passation/réussite
- Échec/erreur
- En cours de réalisation
- Inconnu
Ces badges peuvent être intégrés dans des fichiers README, des tableaux de bord ou des sites Web de documentation.
Pourquoi utiliser les badges de statut de déploiement?
- Visibilité instantanée : Vérifiez rapidement si le dernier déploiement de votre projet est sain.
- Communication d'équipe: Gardez tout le monde aligné sur le statut de construction et de déploiement.
- Public Confidence : Montrez aux parties prenantes ou aux utilisateurs open-source la santé de votre projet.
- Automation Feedback : Intégrez-vous aux pipelines CI/CD pour mettre à jour les badges automatiquement.
Fonctionnement des badges de projet
Les badges de déploiement fonctionnent généralement en se connectant à votre service CI/CD ou de déploiement. Le service met à jour l’image du badge dynamiquement en fonction de l’état de déploiement actuel. Le badge est accessible via une URL, qui change d’apparence en fonction de l’état.
Par exemple :
[https://ci-service.com/badge/project-id/status.svg](https://ci-service.com/badge/project-id/status.svg)
Cette URL renverra un badge SVG indiquant « réussi » si le dernier déploiement a réussi, ou « échoué » si ce n’est pas le cas.
Ajout d'un badge d'état de déploiement à votre projet
-
Obtenir l'URL du badge La plupart des plateformes CI/CD fournissent des URL de badge pour chaque projet ou workflow.
-
Intégrer Badge dans README ou Docs Ajoutez l'URL du badge sous forme d'image dans votre fichier README.md ou votre documentation.
- Assurer les mises à jour de badge automatiquement Configurez votre pipeline CI/CD ou votre système de déploiement pour mettre à jour l’état du badge après chaque exécution.
Services et formats de badges communs
| Service | Description : | Format de badge |
|---|---|---|
| Actions de GitHub | CI/CD pour les dépôts GitHub | SVG |
| Travis CI | Service d'intégration continue | SVG, PNG |
| CircleCI | CI/CD basé sur le cloud | SVG |
| Jenkins | Serveur d'automatisation open-source | SVG |
| Personnalisé | CI/CD auto-hébergé ou propriétaire | URL personnalisées |
Les meilleures pratiques
- Gardez les badges visibles: Placez des badges là où les contributeurs et les utilisateurs visitent fréquemment.
- Utilisez des couleurs significatives: Rouge pour échouer, vert pour passer, jaune pour en cours.
- Fournir des liens de badge : Liez les badges au tableau de bord CI/CD pour un dépannage rapide.
- Sécurisez vos badges : Utilisez des URL HTTPS pour éviter les avertissements de sécurité.
Glossaire
- Badge : Un petit indicateur visuel, souvent une image SVG.
- CI/CD : Intégration continue et pipeline de déploiement continu.
- État du déploiement : État actuel ou réussite du déploiement d’un projet.
- SVG: Format graphique vectoriel évolutif, idéal pour les badges.
Les badges de projet améliorent la transparence et favorisent une meilleure communication en rendant l’état de déploiement de votre projet facile à voir et à comprendre. Intégrez-les à vos flux de travail pour garder tout le monde informé et confiant.
