Déclencheurs Web GitHub

Les déclencheurs Web GitHub sont configurés pour surveiller les événements dans un référentiel ou une organisation GitHub .

Présentation

Les déclencheurs Web GitHub écoutent des événements spécifiques dans une organisation GitHubou un référentiel. Lorsque les événements se produisent dans l\'organisation ou le référentiel, le déclencheur lance le flux de travail d\'automatisation configuré.

Authentification

Les déclencheurs Web GitHub utilisent les Jetons d\'accès personnels pour l\'authentification des utilisateurs et ne nécessitent pas de connexion OAuth. Pour plus d\'informations sur la création et la gestion des Jetons d\'accès personnel, voir Gestion de vos jetons d\'accès personnel. Le déclencheur Web GitHub prend en charge les jetons d\'accès classiques et à granularité fine. Assurez-vous que les Jetons d\'accès personnel sont valides.

Vous pouvez stocker ce jeton dans le Credential Vault. Voir Informations d'identification et lockers dans le Credential Vault pour en savoir plus sur le stockage et la gestion des identifiants.

Événements pris en charge

Les déclencheurs web GitHub prennent en charge les événements suivants aux niveaux de l\'organisation et du référentiel :

Événements Description
Créer Lors de la création d\'un fichier, d\'une branche ou d\'un tag.
Fourche Lorsqu\'une fourche est créée dans un référentiel.
Commentaire sur le problème Lorsqu\'un commentaire est ajouté à un ticket ou à une demande de tirage.
Problèmes Lorsqu\'un problème est créé au niveau du référentiel.
Étiquette Lorsqu\'une étiquette est ajoutée à ou retirée d\'un problème ou d\'une demande de tirage.
Demande de tirage Lorsqu\'une demande de tirage est effectuée dans une branche au sein du référentiel.
Révision de la demande de tirage Lorsque des commentaires de révision sont ajoutés à la demande de tirage.
Push Lorsqu\'il y a un push vers une branche de référentiel.
Favori Lorsqu\'un référentiel est mis en favori
Regarder Lorsque l\'option de surveillance est activée pour des événements spécifiques au sein du référentiel.

Prérequis

Assurez-vous que les prérequis suivants sont satisfaits :

  • Une licence Bot Creator ou Citizen Developer.
  • Autorisations Voir mes robots et DÉCLENCHEURS D\'ÉVÉNEMENT.
  • Autorisation Archiver et Extraire pour les dossiers dans lesquels se trouve l\'automatisation.
  • Un Jeton d\'accès personnel GitHub actif.

Paramètres

Les paramètres suivants sont disponibles pour les déclencheurs WebGitHub  :

Capture d\'écran du déclencheur Web de l\'organisation GitHub

Capture d\'écran des paramètres du déclencheur Web du référentiel GitHub

Écouter l\'événement
Sélectionnez un ou plusieurs événements que le déclencheur doit surveiller.
Nom de l\'organisation
Saisissez le nom de l\'organisation GitHub. Ce champ s\'applique uniquement au déclencheur web de l\'organisation GitHub.
Nom du référentiel
Saisissez le nom du référentiel au sein de l\'organisation GitHub. Ce champ s\'applique uniquement au déclencheur Web du référentiel GitHub.
Profil utilisateur
Saisissez le profil utilisateur GitHub. Ce champ s\'applique uniquement au déclencheur Web du référentiel GitHub
Sélectionner le type d\'authentification
Jeton d\'accès personnel est le type d\'authentification par défaut. Vous pouvez soit sélectionner les Jetons d\'accès personnel stockés dans le Credential Vault en utilisant l\'option Choisir dans Identifiant, soit saisir directement les Jetons d\'accès personnel dans l\'option Chaîne non sécurisée.
Réponse (facultatif)
Utilisez l\'option Réponse pour enregistrer les données de réponse du déclencheur dans une variable Enregistrement. Vous pouvez soit créer une nouvelle variable, soit sélectionner une variable existante pour stocker ces données de réponse. Les données de réponse du déclencheur capturent les informations du corps de la réponse de la charge utile de l\'API webhook GitHub sous forme de paires clé-valeur. Utilisez la clé comme nom dans la variable Enregistrer, permettant à ces données de servir d\'entrées pour d\'autres actions dans l\'automatisation.
Les déclencheurs Web GitHub analysent la charge utile de paires clé-valeur du webhook en utilisant une notation par point (.). Vous devez suivre le même format pour construire l\'expression pour la variable Enregistrer. Par exemple, pour utiliser l\'identifiant du référentiel comme expression, vous devez saisir repository.id comme clé. Pour plus d\'informations sur la documentation de la charge utile du webhook GitHub, voir GitHub webook events and payload.
Une fois que le robot a terminé son exécution, le Audit log enregistre les données de réponse du déclencheur dans une exécution de robot par événement déclencheur.