Github Actions : qwen-code-action

Aperçu

qwen-code-action est une GitHub Action qui intègre Qwen Code  dans votre flux de développement via l’[interface en ligne de commande Qwen Code]. Elle agit à la fois comme un agent autonome pour les tâches de codage routinières critiques et comme un collaborateur à la demande auquel vous pouvez rapidement déléguer du travail.

Utilisez-la pour effectuer des revues de pull requests GitHub, trier les problèmes, réaliser des analyses et modifications de code, et plus encore en utilisant Qwen Code  de manière conversationnelle (par exemple, @qwencoder fix this issue) directement depuis vos dépôts GitHub.

Fonctionnalités

• Automatisation : Déclenchez des workflows en fonction d’événements (par exemple, ouverture d’un ticket) ou de planifications (par exemple, exécution nocturne).
• Collaboration à la demande : Déclenchez des workflows dans les commentaires de tickets et de pull requests en mentionnant le Qwen Code CLI (par exemple, @qwencoder /review).
• Extensibilité avec des outils : Exploitez les capacités d’appel d’outils des modèles Qwen Code pour interagir avec d’autres interfaces de ligne de commande comme le GitHub CLI  (gh).
• Personnalisable : Utilisez un fichier QWEN.md dans votre dépôt pour fournir des instructions et un contexte spécifiques au projet au Qwen Code CLI.

Démarrage rapide

Commencez à utiliser Qwen Code CLI dans votre dépôt en quelques minutes seulement :

1. Obtenir une clé API Qwen

Récupérez votre clé API depuis DashScope  (plateforme IA d’Alibaba Cloud)

2. Ajoutez-la en tant que secret GitHub

Stockez votre clé API sous le nom de secret QWEN_API_KEY dans votre dépôt :

• Allez dans les Paramètres > Secrets et variables > Actions de votre dépôt
• Cliquez sur Nouveau secret de dépôt
• Nom : QWEN_API_KEY, Valeur : votre clé API

3. Mettez à jour votre .gitignore

Ajoutez les entrées suivantes à votre fichier .gitignore :

# Paramètres de qwen-code-cli
.qwen/

# Identifiants d'application GitHub
gha-creds-*.json

4. Choisissez un workflow

Vous avez deux options pour configurer un workflow :

Option A : Utiliser la commande de configuration (Recommandé)

1. Démarrez Qwen Code CLI dans votre terminal :

   qwen

2. Dans Qwen Code CLI dans votre terminal, tapez :

   /setup-github

Option B : Copier manuellement les workflows

1. Copiez les workflows pré-construits depuis le répertoire examples/workflows vers le répertoire .github/workflows de votre dépôt. Remarque : le workflow qwen-dispatch.yml doit également être copié, car il déclenche l’exécution des workflows.

5. Essayez-le

Revue de Pull Request :

• Ouvrez une pull request dans votre dépôt et attendez la revue automatique
• Commentez @qwencoder /review sur une pull request existante pour déclencher manuellement une revue

Tri des Issues :

• Ouvrez une issue et attendez le tri automatique
• Commentez @qwencoder /triage sur des issues existantes pour déclencher manuellement le tri

Assistance IA Générale :

• Dans n’importe quelle issue ou pull request, mentionnez @qwencoder suivi de votre demande
• Exemples :
  • @qwencoder explain this code change
  • @qwencoder suggest improvements for this function
  • @qwencoder help me debug this error
  • @qwencoder write unit tests for this component

Workflows

Cette action fournit plusieurs workflows pré-construits pour différents cas d’utilisation. Chaque workflow est conçu pour être copié dans le répertoire .github/workflows de votre dépôt et personnalisé selon vos besoins.

Dispatch du Code Qwen

Ce workflow agit comme un répartiteur central pour l’interface en ligne de commande (CLI) de Qwen Code, acheminant les requêtes vers le workflow approprié selon l’événement déclencheur et la commande fournie dans le commentaire. Pour un guide détaillé sur la configuration du workflow de répartition, rendez-vous sur la documentation du workflow de dispatch du Code Qwen.

Tri des tickets

Cette action peut être utilisée pour trier automatiquement les tickets GitHub ou selon une planification. Pour un guide détaillé sur la mise en place du système de tri des tickets, consultez la documentation du workflow de tri des tickets GitHub.

Revue de pull request

Cette action permet d’examiner automatiquement les pull requests lorsqu’elles sont ouvertes. Pour un guide détaillé sur la configuration du système de revue des pull requests, rendez-vous sur la documentation du workflow de revue des PR GitHub.

Assistant CLI Qwen Code

Ce type d’action peut être utilisé pour invoquer un assistant IA Qwen Code conversationnel et polyvalent dans les pull requests et les issues afin d’accomplir une grande variété de tâches. Pour un guide détaillé sur la configuration du workflow CLI Qwen Code polyvalent, rendez-vous dans la documentation du workflow de l’assistant Qwen Code.

Configuration

Entrées

• qwen*api_key : (Optionnel) La clé API pour l’API Qwen.

• qwen*cli_version : (Optionnel, par défaut : latest) La version du CLI Qwen Code à installer. Peut être “latest”, “preview”, “nightly”, un numéro de version spécifique, ou une branche, un tag ou un commit git. Pour plus d’informations, voir les versions du CLI Qwen Code .

• qwen*debug : (Optionnel) Activer la journalisation de débogage et le streaming de sortie.

• qwen*model : (Optionnel) Le modèle à utiliser avec Qwen Code.

• prompt : (Optionnel, par défaut : You are a helpful assistant.) Une chaîne passée à l’argument --prompt du CLI Qwen Code.

• settings : (Optionnel) Une chaîne JSON écrite dans .qwen/settings.json pour configurer les paramètres du projet du CLI. Pour plus de détails, voir la documentation sur les fichiers de configuration .

• use*qwen_code_assist : (Optionnel, par défaut : false) Indique s’il faut utiliser Code Assist pour accéder au modèle Qwen Code au lieu de la clé API Qwen Code par défaut. Pour plus d’informations, voir la documentation du CLI Qwen Code .

• use*vertex_ai : (Optionnel, par défaut : false) Indique s’il faut utiliser Vertex AI pour accéder au modèle Qwen Code au lieu de la clé API Qwen Code par défaut. Pour plus d’informations, voir la documentation du CLI Qwen Code .

• extensions : (Optionnel) Une liste d’extensions du CLI Qwen Code à installer.

• upload*artifacts : (Optionnel, par défaut : false) Indique s’il faut télécharger les artefacts vers l’action GitHub.

• use*pnpm : (Optionnel, par défaut : false) Indique s’il faut utiliser pnpm au lieu de npm pour installer qwen-code-cli.

• workflow*name : (Optionnel, par défaut : ${{ github.workflow }}) Le nom du workflow GitHub, utilisé à des fins de télémétrie.

Sorties

• summary : La sortie résumée de l’exécution du CLI Qwen Code.

• error : La sortie d’erreur de l’exécution du CLI Qwen Code, le cas échéant.

Variables de dépôt

Nous recommandons de définir les valeurs suivantes en tant que variables de dépôt afin qu’elles puissent être réutilisées dans tous les workflows. Vous pouvez également les définir en ligne comme entrées d’action dans des workflows individuels ou pour remplacer les valeurs au niveau du dépôt.

Pour ajouter une variable de dépôt :

1. Allez dans Paramètres > Secrets et variables > Actions > Nouvelle variable de votre dépôt.
2. Entrez le nom et la valeur de la variable.
3. Enregistrez.

Pour plus de détails sur les variables de dépôt, consultez la documentation GitHub sur les variables .

Secrets

Vous pouvez définir les secrets suivants dans votre dépôt :

Pour ajouter un secret :

1. Allez dans Paramètres > Secrets et variables > Actions > Nouveau secret de dépôt de votre dépôt.
2. Entrez le nom et la valeur du secret.
3. Enregistrez.

Pour plus d’informations, consultez la documentation officielle GitHub sur la création et l’utilisation des secrets chiffrés .

Authentification

Cette action nécessite une authentification auprès de l’API GitHub et éventuellement auprès des services Qwen Code.

Authentification GitHub

Vous pouvez vous authentifier auprès de GitHub de deux manières :

1. GITHUB_TOKEN par défaut : Pour des cas d’utilisation plus simples, l’action peut utiliser le GITHUB_TOKEN fourni par défaut par le workflow.
2. Application GitHub personnalisée (Recommandé) : Pour une authentification plus sécurisée et flexible, nous recommandons de créer une application GitHub personnalisée.

Pour des instructions détaillées sur la configuration de l’authentification pour Qwen et GitHub, rendez-vous sur la documentation d’authentification.

Extensions

La CLI Qwen Code peut être étendue avec des fonctionnalités supplémentaires via des extensions. Ces extensions sont installées depuis leur source dans leurs dépôts GitHub.

Pour des instructions détaillées sur la manière de configurer et d’utiliser les extensions, rendez-vous sur la documentation des extensions.

Bonnes pratiques

Pour garantir la sécurité, la fiabilité et l’efficacité de vos flux de travail automatisés, nous vous recommandons fortement de suivre nos bonnes pratiques. Ces directives couvrent des domaines clés tels que la sécurité du dépôt, la configuration des flux de travail et la surveillance.

Les recommandations principales incluent :

• Sécurisation de votre dépôt : Mettre en place une protection des branches et des tags, et restreindre les approbateurs des pull requests.
• Surveillance et audit : Consulter régulièrement les journaux d’actions et activer OpenTelemetry pour obtenir des informations plus détaillées sur les performances et le comportement.

Pour un guide complet sur la sécurisation de votre dépôt et de vos flux de travail, veuillez consulter notre documentation sur les bonnes pratiques.

Personnalisation

Créez un fichier QWEN.md à la racine de votre dépôt afin de fournir un contexte et des instructions spécifiques au projet pour Qwen Code CLI. Cela est utile pour définir les conventions de codage, les modèles architecturaux ou d’autres directives que le modèle doit suivre pour un dépôt donné.

Contribution

Les contributions sont les bienvenues ! Consultez le Guide de contribution de Qwen Code CLI pour plus de détails sur la façon de commencer.