Configuración de un devfile en Amazon Q - Amazon Q Developer

Configuración de un devfile en Amazon Q

Para que Amazon Q pueda probar las sugerencias de código que genera en respuesta a un comando /dev, debe configurar un devfile. Puede:

  • Hacer que Amazon Q genere un devfile para usted en función del contexto de su proyecto.

  • Crear un devfile usted mismo.

Para obtener más información sobre los devfiles y las pruebas con Amazon Q, consulte Prueba de sugerencias de código generadas por el comando “/dev” de Amazon Q.

Cómo hacer que Amazon Q le genere un devfile

  1. En el IDE, ejecute un comando /dev. Amazon Q genera una sugerencia sin probar, que se presenta en la ventana de chat.

  2. Al final de la sugerencia, seleccione el botón Generar devfile para crear código. Amazon Q genera un devfile.

  3. Guarde el archivo como devfile.yaml en la carpeta raíz de su proyecto.

    Tras guardar el devfile, Amazon Q empezará a usarlo la próxima vez que se utilice el comando /dev.

  4. (Opcional pero recomendado) Confirme y envíe el devfile de manera que esté disponible para otros usuarios.

Cómo configurar su propio devfile

  1. Comience con un devfile básico. Puede hacer que Amazon Q le genere uno (consulte el procedimiento anterior) o bien puede usar uno de los ejemplos en Ejemplos de devfiles en Amazon Q Developer.

  2. Modifique el devfile para que se adapte a sus necesidades, siguiendo las pautas de la siguiente sección, Guidelines for configuring your own devfile.

  3. Guarde el archivo como devfile.yaml en la carpeta raíz de su proyecto.

    Tras guardar el devfile, Amazon Q empezará a usarlo la próxima vez que se utilice el comando /dev.

  4. (Opcional pero recomendado) Confirme y envíe el devfile de manera que esté disponible para otros usuarios.

Directrices para configurar su propio devfile

  • La imagen de Docker especificada en image: debe residir en un registro de imágenes público, como DockerHub o un registro público de Amazon ECR. No se admiten los registros privados.

  • El devfile debe ajustarse al esquema de devfile 2.2.0.

  • No se admiten todos los objetos del esquema devfile 2.2.0. Amazon Q solo admite los comandos install, build y test. Puede incluir otros comandos, pero no se ejecutarán.

  • Los comandos en commands: deben tardar menos de cinco minutos en ejecutarse en total. El tiempo de respuesta se agotará tras cinco minutos.

  • Si necesita hacer referencia a artefactos, deben residir en un repositorio de artefactos público como PyPI o npmjs.com. Actualmente, no se admiten repositorios de artefactos privados.

  • No haga referencia a recursos de AWS (ni a ningún otro recurso) que requieran acceso autenticado, como los buckets de Amazon S3. El motivo es que el contenedor de Docker del entorno de desarrollo está aislado y solo tiene acceso a los recursos públicos de Internet.