Skip to main content

Welcome to a Grasp lesson

Create a free account to keep studying and create your own study path.

Lesson 36

Publier un commentaire sur une pull request GitHub via l'API n8n

Recommended resources

Bonjour ! Dans la leçon précédente, nous avons construit un workflow capable de réagir à une pull request et de récupérer la liste des fichiers modifiés en interrogeant l'API de GitHub. Nous avons ainsi la matière première nécessaire pour notre future analyse de code.

Aujourd'hui, nous allons fermer la boucle de communication. Notre objectif est de permettre à notre workflow de répondre, c'est-à-dire de poster un commentaire directement sur la pull request qui l'a déclenché. Cette étape est la fondation sur laquelle nous construirons la publication des revues de code générées par l'IA. En maîtrisant cette interaction, nous nous rapprochons de notre but : l'automatisation complète du cycle de vie CI/CD.

1. Agir sur GitHub : Le Nœud d'Action

Nous allons de nouveau utiliser le nœud GitHub. Alors que la dernière fois nous l'avons configuré pour une opération de lecture (API Call avec GET), nous allons maintenant l'utiliser pour une opération d'écriture.

L'API de GitHub est conçue de manière assez intuitive. Dans leur terminologie, une pull request est une forme d' "issue". Par conséquent, de nombreuses actions relatives aux commentaires se trouvent sous la ressource Issue. Nous allons donc chercher une action nous permettant de créer un commentaire.


2. Référencer les Données de la Source

Reprenons notre workflow là où nous l'avions laissé. Il est actuellement composé de deux nœuds :

  1. GitHub Trigger (déclencheur sur une PR)
  2. GitHub - Get Files (un nœud GitHub en mode API Call qui récupère les fichiers)

Nous allons ajouter un troisième nœud, GitHub - Post Comment, pour publier notre message. Ce nœud aura besoin de plusieurs informations pour savoir où poster le commentaire :

  • Le nom du propriétaire du dépôt (owner).
  • Le nom du dépôt (repository).
  • Le numéro de la pull request.

Le problème est que ces informations ne proviennent pas du nœud qui le précède immédiatement (GitHub - Get Files), mais du tout premier nœud, le GitHub Trigger.

Jusqu'à présent, nous avons utilisé des expressions comme {{ $json.pull_request.number }}. Cette syntaxe $json est un raccourci qui fait référence à la sortie du nœud immédiatement précédent. Comment faire pour remonter plus loin dans la chaîne ?

n8n propose une syntaxe plus explicite et puissante qui permet de cibler n'importe quel nœud du workflow par son nom :

{{ $('Nom du Nœud').item.json.chemin.vers.la.donnee }}

C'est une compétence essentielle dans n8n. Elle vous donne la liberté de structurer vos workflows comme vous le souhaitez, en piochant des données de n'importe quelle étape antérieure. Cela implique aussi qu'il est crucial de donner des noms clairs et uniques à vos nœuds !


3. Construction du Workflow de Commentaire

Ajoutons maintenant ce troisième nœud à notre workflow.

  1. Après votre nœud qui récupère les fichiers, ajoutez un nouveau nœud GitHub. Renommez-le immédiatement en "Post Comment" pour plus de clarté.
  2. Credentials: Sélectionnez les mêmes identifiants GitHub que précédemment.
  3. Configurez les paramètres de l'action :
    • Resource: Choisissez Issue.
    • Operation: Choisissez Create Comment.
  4. Remplissez les champs requis en utilisant la nouvelle syntaxe de référencement. Si votre nœud de déclenchement s'appelle bien "GitHub Trigger", les expressions seront :
    • Owner: {{ $('GitHub Trigger').item.json.repository.owner.login }}
    • Repository: {{ $('GitHub Trigger').item.json.repository.name }}
    • Issue/PR Number: {{ $('GitHub Trigger').item.json.pull_request.number }}
    • Body: Pour l'instant, écrivons un message simple et statique. Par exemple : Ce commentaire a été posté automatiquement par mon workflow n8n. L'analyse du code peut commencer !

Votre configuration devrait ressembler à ceci :

Cette image montre une interface similaire, bien qu'utilisant un nœud HTTP Request. Dans notre cas, nous utilisons le nœud GitHub dédié qui simplifie la gestion de l'URL et de l'authentification. Le principe reste le même : spécifier une cible (URL/dépôt) et un contenu (Body).

4. Test et Vérification

Il est temps de tester. Exécutez le test de ce nouveau nœud ("Test step"). Si les nœuds précédents ont des données de test valides, n8n va exécuter l'appel à l'API de GitHub.

Rendez-vous ensuite sur l'interface de GitHub, sur la pull request que vous avez utilisée pour vos tests. Vous devriez y voir apparaître le commentaire que vous venez de définir dans le champ Body !

L'article ci-dessous, bien qu'il couvre un workflow complet avec une IA, illustre parfaitement ce que nous venons de réaliser.

Automate GitHub Code Reviews with n8n's AI Agent

Cet article montre l'intégration d'une IA pour la revue de code, mais se concentre sur les nœuds essentiels pour interagir avec GitHub.

Concentrez-vous sur la section "Post a Review Comment", qui montre la configuration du nœud GitHub pour ajouter un commentaire. Ensuite, regardez le résultat dans la section suivante, sous "Now, let’s see it in action", où l'on voit bien le commentaire de l'agent apparaître sur la PR.

Cet exemple confirme que notre approche est la bonne et qu'elle est utilisée dans des scénarios concrets et avancés.


Conclusion

Félicitations ! Vous avez maintenant un workflow qui non seulement écoute GitHub, mais qui est aussi capable de lui répondre. C'est une étape majeure vers une véritable automatisation du dialogue entre vos outils.

Voici les points essentiels de cette leçon :

  • Le nœud d'action GitHub peut être utilisé pour des opérations d'écriture, comme la création de commentaires, en utilisant la ressource Issue et l'opération Create Comment.
  • La syntaxe {{ $('Nom du Nœud').item.json... }} est un outil indispensable pour accéder aux données de n'importe quel nœud précédent, vous libérant de la contrainte du flux linéaire.
  • Nous avons créé un cycle complet : Déclenchement (GitHub) -> Traitement (n8n) -> Action (GitHub).

Le commentaire que nous postons est pour l'instant statique. Dans la prochaine leçon, nous allons enfin faire entrer l'intelligence artificielle en scène. Nous apprendrons à construire un prompt dynamique en utilisant les "diffs" de code récupérés à l'étape précédente, et à insérer la réponse de l'IA dans le corps de ce commentaire.