Konfigurieren einer Devfile in Amazon Q - Amazon Q Developer

Konfigurieren einer Devfile in Amazon Q

Damit Amazon Q die Codevorschläge testen kann, die es als Antwort auf einen /dev-Befehl generiert, müssen Sie eine Devfile konfigurieren. Führen Sie dazu einen der folgenden Schritte aus:

  • Lassen Sie Amazon Q eine Devfile für Sie generieren, die auf dem Kontext Ihres Projekts basiert.

  • Erstellen Sie selbst eine Devfile.

Weitere Informationen zu Devfiles und Tests mit Amazon Q finden Sie unter Testen von Codevorschlägen, die mit dem Amazon-Q-Befehl „/dev“ generiert wurden.

So lassen Sie Amazon Q eine Devfile generieren

  1. Führen Sie in Ihrer IDE einen /dev-Befehl aus. Amazon Q generiert einen ungetesteten Vorschlag, den es Ihnen im Chat-Fenster präsentiert.

  2. Wählen Sie am Ende des Vorschlags die Schaltfläche Generate devfile to build code aus. Amazon Q generiert eine Devfile.

  3. Speichern Sie die Datei mit dem Namen devfile.yaml im Stammordner Ihres Projekts.

    Nach dem Speichern der Devfile verwendet Amazon Q sie, sobald der Befehl /dev das nächste Mal verwendet wird.

  4. (Optional, aber empfohlen) Übergeben Sie die Devfile per Commit und übertragen Sie sie per Push, sodass sie anderen Benutzern zur Verfügung steht.

So konfigurieren Sie eine eigene Devfile

  1. Beginnen Sie mit einer einfachen Devfile. Sie können Amazon Q eine Datei für Sie generieren lassen (siehe vorheriges Verfahren) oder Sie verwenden eines der Beispiele unter Beispiel-Devfiles in Amazon Q Developer.

  2. Passen Sie die Devfile Ihren Bedürfnissen an und folgen Sie dabei den Richtlinien im nächsten Abschnitt Guidelines for configuring your own devfile.

  3. Speichern Sie die Datei mit dem Namen devfile.yaml im Stammordner Ihres Projekts.

    Nach dem Speichern der Devfile verwendet Amazon Q sie, sobald der Befehl /dev das nächste Mal verwendet wird.

  4. (Optional, aber empfohlen) Übergeben Sie die Devfile per Commit und übertragen Sie sie per Push, sodass sie anderen Benutzern zur Verfügung steht.

Richtlinien für die Konfiguration einer eigenen Devfile

  • Das in image: angegebene Docker-Image muss sich in einer öffentlichen Image-Registry wie DockerHub oder einer öffentlichen Amazon-ECR-Registry befinden. Private Registrys werden nicht unterstützt.

  • Die Devfile muss dem Devfile 2.2.0 Schema entsprechen.

  • Nicht alle Objekte im Devfile 2.2.0 Schema werden unterstützt. Amazon Q unterstützt nur die Befehle install, build und test. Sie können andere Befehle einbeziehen, diese werden jedoch nicht ausgeführt.

  • Die gesamte Ausführung der Befehle in commands: muss weniger als fünf Minuten dauern. Nach fünf Minuten tritt ein Timeout auf.

  • Wenn Sie auf Artefakte verweisen möchten, müssen sich diese in einem öffentlichen Artefakt-Repository wie PyPI oder npmjs.com befinden. Private Artefakt-Repositorys werden nicht unterstützt.

  • Verweisen Sie nicht auf AWS-Ressourcen (oder andere Ressourcen), die einen authentifizierten Zugriff erfordern, wie Amazon-S3-Buckets. Das liegt daran, dass sich der Docker-Container der Entwicklungsumgebung in einer Sandbox befindet und nur Zugriff auf öffentliche Ressourcen im Internet hat.