Configuration d’un fichier de développement dans Amazon Q - Amazon Q Developer

Configuration d’un fichier de développement dans Amazon Q

Pour permettre à Amazon Q de tester les suggestions de code qu’il génère en réponse à une commande /dev, vous devez configurer un fichier de développement. Vous avez le choix entre les options suivantes :

  • Demander à Amazon Q de générer un fichier de développement pour vous en fonction du contexte de votre projet

  • Créer vous-même un fichier de développement

Pour plus d’informations sur les fichiers de développement et les tests d’Amazon Q, consultez Test des suggestions de code générées par la commande /dev d’Amazon Q.

Pour qu’Amazon Q génère un fichier de développement pour vous

  1. Dans votre IDE, exécutez une commande /dev. Amazon Q génère une suggestion non testée, qu’il vous présente dans la fenêtre de chat.

  2. À la fin de la suggestion, sélectionnez le bouton Générer un fichier de développement pour créer le code. Amazon Q génère un fichier de développement.

  3. Enregistrez le fichier devfile.yaml dans le dossier racine de votre projet.

    Une fois le fichier de développement enregistré, Amazon Q commencera à l’utiliser la prochaine fois que la commande /dev sera utilisée.

  4. (Facultatif mais recommandé) Validez et publiez le fichier de développement afin de le mettre à la disposition des autres utilisateurs.

Pour configurer votre propre fichier de développement

  1. Commencez par créer un fichier de développement de base. Vous pouvez demander à Amazon Q d’en générer un pour vous (voir la procédure précédente), ou vous pouvez utiliser l’un des exemples présentés dans Exemples de fichiers de développement dans Amazon Q Developer.

  2. Modifiez le fichier de développement en fonction de vos besoins, en suivant les instructions de la section suivante, Guidelines for configuring your own devfile.

  3. Enregistrez le fichier devfile.yaml dans le dossier racine de votre projet.

    Une fois le fichier de développement enregistré, Amazon Q commencera à l’utiliser la prochaine fois que la commande /dev sera utilisée.

  4. (Facultatif mais recommandé) Validez et publiez le fichier de développement afin de le mettre à la disposition des autres utilisateurs.

Directives de configuration de votre propre fichier de développement

  • L’image Docker spécifiée dans image: doit résider dans un registre d’images public tel que DockerHub ou un registre Amazon ECR public. Les registres privés ne sont pas pris en charge.

  • Le fichier de développement doit être conforme au schéma devfile 2.2.0.

  • Tous les objets du schéma devfile 2.2.0 ne sont pas pris en charge. Amazon Q prend uniquement en charge les commandes install, build et test. Vous pouvez inclure d’autres commandes, mais elles ne seront pas exécutées.

  • L’exécution des commandes de commands: doit prendre moins de cinq minutes au total. Ces commandes expirent au bout de cinq minutes.

  • Si vous devez référencer des artefacts, ces derniers doivent résider dans un référentiel public d’artefacts tel que PyPI ou npmjs.com. Les référentiels privés d’artefacts ne sont pas pris en charge.

  • Ne référencez pas les ressources AWS (ou toute autre ressource) nécessitant un accès authentifié, telles que les compartiments Amazon S3. En effet, le conteneur Docker de l’environnement de développement est placé dans un environnement de test et n’a accès qu’aux ressources publiques sur Internet.