Ejemplos de devfiles en Amazon Q Developer - Amazon Q Developer
Ejemplo de PythonEjemplo de nodoExplicación de ejemplos

Ejemplos de devfiles en Amazon Q Developer

Los siguientes ejemplos muestran devfiles que cumplen con la especificación de devfile y que son adecuados para su uso con Amazon Q. Los ejemplos se explican al final de esta página.

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

Ejemplo de Python

El siguiente ejemplo muestra un devfile que puede usar con un proyecto de Python.

schemaVersion: 2.0.0
components:
  - name: dev 
    container:
      image: public.ecr.aws/aws-mde/universal-image:latest
commands:
  - id: install
    exec:
      component: dev
      commandLine: "pip3.11 install -r requirements.txt"
  - id: test 
    exec:
      component: dev
      commandLine: "python3.11 manage.py makemigrations && python3.11 manage.py test"

Ejemplo de nodo

En el ejemplo siguiente se muestra un devfile que puede utilizar con un proyecto Node.js.

schemaVersion: 2.0.0
components:
  - name: dev 
    container:
      image: public.ecr.aws/aws-mde/universal-image:latest
commands:
  - id: install
    exec:
      component: dev
      commandLine: "npm install"
  - id: build
    exec:
      component: dev
      commandLine: "npm run build"
  - id: test 
    exec:
      component: dev
      commandLine: "npm run test"

Explicación de ejemplos

En la siguiente tabla se describe cada línea o bloque de código de los ejemplos de devfile anteriores.

Línea o bloque de código Descripción 
schemaVersion: 2.0.0

Especifica la versión del esquema devfile. Amazon Q solo admite la versión 2.0.0 del esquema.

 
components:

Una lista de componentes para implementar en el entorno de desarrollo.

 
- name: dev
  container:
    image: public.ecr.aws/aws-mde/universal-image:latest

Indica que se debe utilizar la última imagen de Docker imagen universal disponible en el Amazon Elastic Container Registry (Amazon ECR) como entorno de desarrollo. Puede cambiar la versión de esta imagen o sustituirla por una propia. Para obtener más información, consulte Contenido de la imagen universal.

 
commands:

Una lista de comandos que se deben ejecutar.

 
  - id: install|build|test
    exec:
      component: dev
      commandLine: "cli-instructions"

Un comando install, build o test. Amazon Q ejecuta las instrucciones cli-instructions en el entorno de desarrollo, en la imagen universal (o en cualquier imagen que se especifique en image:). Las cli-instructions serán diferentes según el contexto del proyecto. Puede cambiar estos comandos para adaptarlos a sus necesidades.