Claude Code GitHub Actions
Apprenez à intégrer Claude Code dans votre flux de travail de développement avec Claude Code GitHub Actions
Claude Code GitHub Actions apporte l’automatisation alimentée par l’IA à votre flux de travail GitHub. Avec une simple mention @claude
dans n’importe quelle PR ou issue, Claude peut analyser votre code, créer des pull requests, implémenter des fonctionnalités et corriger des bugs - tout en respectant les standards de votre projet.
Claude Code GitHub Actions est actuellement en bêta. Les fonctionnalités et la fonctionnalité peuvent évoluer à mesure que nous affinons l’expérience.
Claude Code GitHub Actions est construit au-dessus du Claude Code SDK, qui permet l’intégration programmatique de Claude Code dans vos applications. Vous pouvez utiliser le SDK pour construire des flux de travail d’automatisation personnalisés au-delà de GitHub Actions.
Pourquoi utiliser Claude Code GitHub Actions ?
- Création instantanée de PR : Décrivez ce dont vous avez besoin, et Claude crée une PR complète avec tous les changements nécessaires
- Implémentation automatisée de code : Transformez les issues en code fonctionnel avec une seule commande
- Respecte vos standards : Claude respecte vos directives
CLAUDE.md
et les modèles de code existants - Configuration simple : Commencez en quelques minutes avec notre installateur et clé API
- Sécurisé par défaut : Votre code reste sur les runners de Github
Que peut faire Claude ?
Claude Code fournit des GitHub Actions puissantes qui transforment votre façon de travailler avec le code :
Claude Code Action
Cette GitHub Action vous permet d’exécuter Claude Code dans vos flux de travail GitHub Actions. Vous pouvez l’utiliser pour construire n’importe quel flux de travail personnalisé au-dessus de Claude Code.
Claude Code Action (Base)
La fondation pour construire des flux de travail GitHub personnalisés avec Claude. Ce framework extensible vous donne un accès complet aux capacités de Claude pour créer une automatisation sur mesure.
Configuration
Configuration rapide
La façon la plus simple de configurer cette action est via Claude Code dans le terminal. Ouvrez simplement claude et exécutez /install-github-app
.
Cette commande vous guidera dans la configuration de l’application GitHub et des secrets requis.
- Vous devez être un administrateur de dépôt pour installer l’application GitHub et ajouter des secrets
- Cette méthode de démarrage rapide n’est disponible que pour les utilisateurs directs de l’API Anthropic. Si vous utilisez AWS Bedrock ou Google Vertex AI, veuillez consulter la section Utilisation avec AWS Bedrock & Google Vertex AI.
Configuration manuelle
Si la commande /install-github-app
échoue ou si vous préférez une configuration manuelle, veuillez suivre ces instructions de configuration manuelle :
- Installez l’application GitHub Claude sur votre dépôt : https://github.com/apps/claude
- Ajoutez ANTHROPIC_API_KEY à vos secrets de dépôt (Apprenez comment utiliser les secrets dans GitHub Actions)
- Copiez le fichier de flux de travail depuis examples/claude.yml dans le répertoire
.github/workflows/
de votre dépôt
Après avoir terminé soit la configuration rapide soit la configuration manuelle, testez l’action en taguant @claude
dans un commentaire d’issue ou de PR !
Exemples de cas d’usage
Claude Code GitHub Actions peut vous aider avec une variété de tâches. Pour des exemples complets et fonctionnels, consultez le répertoire d’exemples.
Transformer les issues en PRs
Dans un commentaire d’issue :
Claude analysera l’issue, écrira le code et créera une PR pour révision.
Obtenir de l’aide pour l’implémentation
Dans un commentaire de PR :
Claude analysera votre code et fournira des conseils d’implémentation spécifiques.
Corriger les bugs rapidement
Dans une issue :
Claude localisera le bug, implémentera une correction et créera une PR.
Meilleures pratiques
Configuration CLAUDE.md
Créez un fichier CLAUDE.md
à la racine de votre dépôt pour définir les directives de style de code, les critères de révision, les règles spécifiques au projet et les modèles préférés. Ce fichier guide la compréhension de Claude des standards de votre projet.
Considérations de sécurité
Ne commitez jamais les clés API directement dans votre dépôt !
Utilisez toujours les Secrets GitHub pour les clés API :
- Ajoutez votre clé API comme un secret de dépôt nommé
ANTHROPIC_API_KEY
- Référencez-la dans les flux de travail :
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
- Limitez les permissions d’action à seulement ce qui est nécessaire
- Révisez les suggestions de Claude avant de fusionner
Utilisez toujours les Secrets GitHub (par exemple, ${{ secrets.ANTHROPIC_API_KEY }}
) plutôt que de coder en dur les clés API directement dans vos fichiers de flux de travail.
Optimisation des performances
Utilisez des modèles d’issue pour fournir du contexte, gardez votre CLAUDE.md
concis et focalisé, et configurez des timeouts appropriés pour vos flux de travail.
Coûts CI
Lors de l’utilisation de Claude Code GitHub Actions, soyez conscient des coûts associés :
Coûts GitHub Actions :
- Claude Code s’exécute sur des runners hébergés par GitHub, qui consomment vos minutes GitHub Actions
- Consultez la documentation de facturation de GitHub pour les prix détaillés et les limites de minutes
Coûts API :
- Chaque interaction Claude consomme des tokens API basés sur la longueur des prompts et des réponses
- L’utilisation de tokens varie selon la complexité de la tâche et la taille de la base de code
- Consultez la page de prix de Claude pour les taux de tokens actuels
Conseils d’optimisation des coûts :
- Utilisez des commandes
@claude
spécifiques pour réduire les appels API inutiles - Configurez des limites
max_turns
appropriées pour éviter les itérations excessives - Définissez des
timeout_minutes
raisonnables pour éviter les flux de travail incontrôlés - Considérez l’utilisation des contrôles de concurrence de GitHub pour limiter les exécutions parallèles
Exemples de configuration
Pour des configurations de flux de travail prêtes à utiliser pour différents cas d’usage, incluant :
- Configuration de flux de travail de base pour les commentaires d’issue et de PR
- Révisions de code automatisées sur les pull requests
- Implémentations personnalisées pour des besoins spécifiques
Visitez le répertoire d’exemples dans le dépôt Claude Code Action.
Le dépôt d’exemples inclut des flux de travail complets et testés que vous pouvez copier directement dans votre répertoire .github/workflows/
.
Utilisation avec AWS Bedrock & Google Vertex AI
Pour les environnements d’entreprise, vous pouvez utiliser Claude Code GitHub Actions avec votre propre infrastructure cloud. Cette approche vous donne le contrôle sur la résidence des données et la facturation tout en maintenant la même fonctionnalité.
Prérequis
Avant de configurer Claude Code GitHub Actions avec les fournisseurs cloud, vous avez besoin de :
Pour Google Cloud Vertex AI :
- Un projet Google Cloud avec Vertex AI activé
- Workload Identity Federation configuré pour GitHub Actions
- Un compte de service avec les permissions requises
- Une application GitHub (recommandée) ou utilisez le GITHUB_TOKEN par défaut
Pour AWS Bedrock :
- Un compte AWS avec Amazon Bedrock activé
- Fournisseur d’identité GitHub OIDC configuré dans AWS
- Un rôle IAM avec les permissions Bedrock
- Une application GitHub (recommandée) ou utilisez le GITHUB_TOKEN par défaut
Créer une application GitHub personnalisée (Recommandé pour les fournisseurs 3P)
Pour un meilleur contrôle et sécurité lors de l’utilisation de fournisseurs 3P comme Vertex AI ou Bedrock, nous recommandons de créer votre propre application GitHub :
- Allez sur https://github.com/settings/apps/new
- Remplissez les informations de base :
- Nom de l’application GitHub : Choisissez un nom unique (par exemple, “YourOrg Claude Assistant”)
- URL de la page d’accueil : Le site web de votre organisation ou l’URL du dépôt
- Configurez les paramètres de l’application :
- Webhooks : Décochez “Active” (pas nécessaire pour cette intégration)
- Définissez les permissions requises :
- Permissions de dépôt :
- Contents : Lecture & Écriture
- Issues : Lecture & Écriture
- Pull requests : Lecture & Écriture
- Permissions de dépôt :
- Cliquez sur “Create GitHub App”
- Après la création, cliquez sur “Generate a private key” et sauvegardez le fichier
.pem
téléchargé - Notez votre ID d’application depuis la page des paramètres de l’application
- Installez l’application sur votre dépôt :
- Depuis la page des paramètres de votre application, cliquez sur “Install App” dans la barre latérale gauche
- Sélectionnez votre compte ou organisation
- Choisissez “Only select repositories” et sélectionnez le dépôt spécifique
- Cliquez sur “Install”
- Ajoutez la clé privée comme secret à votre dépôt :
- Allez dans les Paramètres de votre dépôt → Secrets and variables → Actions
- Créez un nouveau secret nommé
APP_PRIVATE_KEY
avec le contenu du fichier.pem
- Ajoutez l’ID de l’application comme secret :
- Créez un nouveau secret nommé
APP_ID
avec l’ID de votre application GitHub
Cette application sera utilisée avec l’action actions/create-github-app-token pour générer des tokens d’authentification dans vos flux de travail.
Alternative pour l’API Anthropic ou si vous ne voulez pas configurer votre propre application Github : Utilisez l’application officielle Anthropic :
- Installez depuis : https://github.com/apps/claude
- Aucune configuration supplémentaire nécessaire pour l’authentification
Configurer l'authentification du fournisseur cloud
Choisissez votre fournisseur cloud et configurez l’authentification sécurisée :
Ajouter les secrets requis
Ajoutez les secrets suivants à votre dépôt (Paramètres → Secrets and variables → Actions) :
Pour l’API Anthropic (Direct) :
-
Pour l’authentification API :
ANTHROPIC_API_KEY
: Votre clé API Anthropic depuis console.anthropic.com
-
Pour l’application GitHub (si vous utilisez votre propre application) :
APP_ID
: L’ID de votre application GitHubAPP_PRIVATE_KEY
: Le contenu de la clé privée (.pem)
Pour Google Cloud Vertex AI
-
Pour l’authentification GCP :
GCP_WORKLOAD_IDENTITY_PROVIDER
GCP_SERVICE_ACCOUNT
-
Pour l’application GitHub (si vous utilisez votre propre application) :
APP_ID
: L’ID de votre application GitHubAPP_PRIVATE_KEY
: Le contenu de la clé privée (.pem)
Pour AWS Bedrock
-
Pour l’authentification AWS :
AWS_ROLE_TO_ASSUME
-
Pour l’application GitHub (si vous utilisez votre propre application) :
APP_ID
: L’ID de votre application GitHubAPP_PRIVATE_KEY
: Le contenu de la clé privée (.pem)
Créer les fichiers de flux de travail
Créez des fichiers de flux de travail GitHub Actions qui s’intègrent avec votre fournisseur cloud. Les exemples ci-dessous montrent des configurations complètes pour AWS Bedrock et Google Vertex AI :
Dépannage
Claude ne répond pas aux commandes @claude
Vérifiez que l’application GitHub est installée correctement, vérifiez que les flux de travail sont activés, assurez-vous que la clé API est définie dans les secrets du dépôt, et confirmez que le commentaire contient @claude
(pas /claude
).
CI ne s’exécute pas sur les commits de Claude
Assurez-vous que vous utilisez l’application GitHub ou une application personnalisée (pas l’utilisateur Actions), vérifiez que les déclencheurs de flux de travail incluent les événements nécessaires, et vérifiez que les permissions de l’application incluent les déclencheurs CI.
Erreurs d’authentification
Confirmez que la clé API est valide et a des permissions suffisantes. Pour Bedrock/Vertex, vérifiez la configuration des identifiants et assurez-vous que les secrets sont nommés correctement dans les flux de travail.
Configuration avancée
Paramètres d’action
La Claude Code Action supporte ces paramètres clés :
Paramètre | Description | Requis |
---|---|---|
prompt | Le prompt à envoyer à Claude | Oui* |
prompt_file | Chemin vers le fichier contenant le prompt | Oui* |
anthropic_api_key | Clé API Anthropic | Oui** |
max_turns | Tours de conversation maximum | Non |
timeout_minutes | Timeout d’exécution | Non |
*Soit prompt
soit prompt_file
requis
**Requis pour l’API Anthropic directe, pas pour Bedrock/Vertex
Méthodes d’intégration alternatives
Bien que la commande /install-github-app
soit l’approche recommandée, vous pouvez aussi :
- Application GitHub personnalisée : Pour les organisations nécessitant des noms d’utilisateur de marque ou des flux d’authentification personnalisés. Créez votre propre application GitHub avec les permissions requises (contents, issues, pull requests) et utilisez l’action actions/create-github-app-token pour générer des tokens dans vos flux de travail.
- GitHub Actions manuel : Configuration directe de flux de travail pour une flexibilité maximale
- Configuration MCP : Chargement dynamique des serveurs Model Context Protocol
Consultez le dépôt Claude Code Action pour une documentation détaillée.
Personnaliser le comportement de Claude
Vous pouvez configurer le comportement de Claude de deux façons :
- CLAUDE.md : Définissez les standards de codage, les critères de révision et les règles spécifiques au projet dans un fichier
CLAUDE.md
à la racine de votre dépôt. Claude suivra ces directives lors de la création de PRs et de la réponse aux demandes. Consultez notre documentation Mémoire pour plus de détails. - Prompts personnalisés : Utilisez le paramètre
prompt
dans le fichier de flux de travail pour fournir des instructions spécifiques au flux de travail. Cela vous permet de personnaliser le comportement de Claude pour différents flux de travail ou tâches.
Claude suivra ces directives lors de la création de PRs et de la réponse aux demandes.