Amazon Q での devfile の設定 - Amazon Q Developer

Amazon Q での devfile の設定

/dev コマンドに応答して、Amazon Q が生成するコード提案をテストできるようにするには、devfile を設定する必要があります。次のいずれかを行うことができます。

  • プロジェクトのコンテキストに基づいて Amazon Q に devfile を生成させる。

  • devfile を自分で作成する。

devfile および Amazon Q でのテストの詳細については、「Amazon Q の '/dev' コマンドによって生成されたコード提案のテスト」を参照してください。

Amazon Q に devfile を生成させるには、次を実行します。

  1. IDE で、/dev コマンドを実行します。Amazon Q は未テストのコード提案を生成し、チャットウィンドウで提示します。

  2. 提案の最後で、[devfile を生成してコードをビルドする] ボタンを選択します。Amazon Q が devfile を生成します。

  3. ファイルを devfile.yaml としてプロジェクトのルートフォルダに保存します。

    devfile を保存すると、Amazon Q は次回 /dev コマンドが使用されたときにその devfile の使用を開始します。

  4. (オプションですが推奨) devfile をコミットしてプッシュし、他のユーザーが使用できるようにします。

独自の devfile を設定するには、次の手順を実行します。

  1. 基本的な devfile から始めます。Amazon Q に生成させるか (前の手順を参照)、Amazon Q Developer の devfile の例 の例のいずれかを使用できます。

  2. 次のセクション「Guidelines for configuring your own devfile」のガイドラインに従って、必要に応じて devfile を変更します。

  3. ファイルを devfile.yaml としてプロジェクトのルートフォルダに保存します。

    devfile を保存すると、Amazon Q は次回 /dev コマンドが使用されたときにその devfile の使用を開始します。

  4. (オプションですが推奨) devfile をコミットしてプッシュし、他のユーザーが使用できるようにします。

独自の devfile を設定するためのガイドライン

  • image: で指定された Docker イメージは、DockerHub などのパブリックイメージレジストリまたはパブリック Amazon ECR レジストリに存在する必要があります。プライベートレジストリはサポートされていません。

  • devfile は devfile 2.2.0 スキーマに準拠している必要があります。

  • devfile 2.2.0 スキーマ内のすべてのオブジェクトがサポートされているわけではありません。Amazon Q は install、build、および test コマンドのみをサポートします。他のコマンドを含めることはできますが、実行されません。

  • commands: のコマンドは、合計で 5 分未満で実行可能である必要があります。5 分後にタイムアウトします。

  • アーティファクトを参照する必要がある場合は、PyPI や npmjs.com などのパブリックアーティファクトリポジトリに存在する必要があります。プライベートアーティファクトリポジトリは、サポートされていません。

  • Amazon S3 バケットなど、認証アクセスを必要とする AWS リソース (または他のリソース) を参照しないでください。これは、開発環境の Docker コンテナがサンドボックス化されており、インターネット上のパブリックリソースにのみアクセスできるためです。