在 Amazon Q 中設定 devfile - Amazon Q Developer

在 Amazon Q 中設定 devfile

若要讓 Amazon Q 測試其為了回應 /dev 命令所產生的程式碼建議，您必須設定 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 命令時開始使用此檔案。

  4. (選用，但建議使用) 遞交並推送 devfile，以供其他使用者使用。

若要設定您自己的 devfile

  1. 從基本 devfile 開始著手。您可以讓 Amazon Q 為您產生 devfile (請參閱先前的程序)，也可以使用 Amazon Q Developer 中的範例 devfile 中的其中一個範例。

  2. 依照下一節 Guidelines for configuring your own devfile 的準則修改 devfile，以符合您的需求。

  3. 將檔案儲存為 devfile.yaml 並放到您專案的根資料夾中。

    儲存 devfile 之後，Amazon Q 將在下次使用 /dev 命令時開始使用此檔案。

  4. (選用，但建議使用) 遞交並推送 devfile，以供其他使用者使用。

設定您自己的 dev 檔案準則

  • 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 等公有成品儲存庫中。不支援私有成品儲存庫。

  • 請勿參考需要經身分驗證才能存取的參考 AWS 資源 (或任何資源)，例如 Amazon S3 儲存貯體。這是因為開發環境的 Docker 容器經過沙盒處理，且只能存取網際網路上的公有資源。