En plus des intégrations permettant de synchroniser vos dépôts (repositories) depuis GitLab ou GitHub, Axify vous permet de générer des webhooks. Cette configuration vise à synchroniser les données relatives au déploiement de votre code vers Axify pour plus de précision et alimente les métriques DORA.
Il est possible de générer et lier plus d’un webhook à un même projet Axify, de le renommer, ou même de le révoquer au besoin.
Pour générer un webhook depuis Axify
- Accédez au projet concerné, puis aux Paramètres de projet.
- Sélectionnez l’onglet Intégrations. C’est ici que vous retrouverez les intégrations actuellement actives et liées à ce projet.
- Dans la section Axe Technique située au bas de la page, sous Déploiement, cliquez sur Générer un webhook.
- Un menu s’affichera. Sélectionnez le webhook à générer.
- L’URL (endpoint) et le jeton secret nécessaires à la configuration du webhook seront automatiquement générés par Axify. Vous pouvez maintenant copier ces informations en cliquant sur
et poursuivre la configuration dans le logiciel concerné.
- Une fois la configuration complétée, assurez-vous de bien Configurer vos environnements de déploiement afin de permettre l'importation de vos données.
Pour plus d’informations sur la configuration propre à certains logiciels, nous vous invitons à consulter les ressources suivantes.
- Documentation officielle de GitLab
- Essentiellement, les events de type déploiement doivent être envoyés au webhook pour assurer la connexion. Cela signifie donc que, lors de la configuration dans GitLab, vous devez :
- Cocher Deployment Events.
- Cocher l’option SSL.
- Décocher l’option Push.
- Pour la partie CI, vous devez utiliser le flow de déploiement de GitLab pour qu’Axify puisse suivre les évènements de déploiement. Vous pouvez vous référer à cette documentation officielle pour de plus amples détails.
- En date du 19 avril 2022, seuls les déploiements effectués en environnement de production sont comptabilisés.
- Essentiellement, les events de type déploiement doivent être envoyés au webhook pour assurer la connexion. Cela signifie donc que, lors de la configuration dans GitLab, vous devez :
- Documentation officielle de GitHub
- Comme pour GitLab, les events de type déploiement de GitHub doivent être envoyés au webhook. Lors de la configuration dans GitHub, vous devez :
- Activer les évènements de type JSON (seuls évènements supportés en date du 28 avril 2022)
- Activer la vérification SSL.
- Sous « Which events would you like to trigger this webhook », sélectionnez uniquement les évènements de type Deployment statuses.
- Cocher la case Active au bas de la page de configuration.
- Cliquer sur Add webhook.
- Il est à noter que, dans la documentation de GitHub sur la configuration des webhooks, il est mentionné au bas de la page qu’un évènement ping est envoyé automatiquement à la création. En date du 28 avril 2022, ce ping échoue automatiquement, mais l’évènement de déploiement fonctionne. Cette fonctionnalité sera supportée dans une prochaine version.
- Comme pour GitLab, les events de type déploiement de GitHub doivent être envoyés au webhook. Lors de la configuration dans GitHub, vous devez :
Pour renommer un webhook
- Suivez les étapes précédentes pour accéder aux intégrations.
- Sous la section Déploiement, repérez le webhook à renommer.
- Cliquez sur
à la droite du nom actuel du webhook concerné. - Modifiez le nom du webhook.
- Pour enregistrer votre modification, cliquez sur √.
- Pour annuler votre modification, cliquez sur X.
Pour révoquer un webhook
- Suivez les étapes précédentes pour accéder aux intégrations.
- Sous la section Déploiement, repérez le webhook à révoquer.
- Cliquez sur Révoquer à la droite de la ligne d’options pour le webhook concerné.
- Une fenêtre de confirmation s’affichera. Pour confirmer la révocation du webhook, cliquez sur Oui, révoquer.
| Attention : Cette action est irréversible. |