Referencia de la especificación de compilación de CodeBuild

Secuencia opcional. Especifica el intérprete de comandos compatible con los sistemas operativos Linux o Windows.

En los sistemas operativos Linux, las etiquetas de intérprete de comandos compatibles son:

En los sistemas operativos Windows, las etiquetas de intérprete de comandos compatibles son:

Obligatorio si se especifica env y desea definir variables de entorno personalizadas en texto sin formato. Contiene una asignación de escalares clave/valor, donde cada asignación representa una única variable de entorno personalizada en texto sin formato. La clave es el nombre de la variable de entorno personalizada, mientras que el valor es el valor de la variable.

Obligatorio si se ha especificado env y desea recuperar variables de entorno personalizadas almacenadas en el almacén de parámetros de Amazon EC2 Systems Manager. Contiene una asignación de pares clave/valor escalares, donde cada asignación representa una única variable de entorno personalizada almacenada en el almacén de parámetros de Amazon EC2 Systems Manager. La clave es el nombre que utilizará más adelante en los comandos de compilación para hacer referencia a esta variable de entorno personalizada, y el valor es el nombre de la variable de entorno personalizada almacenada en el almacén de parámetros de Amazon EC2 Systems Manager. Para almacenar valores confidenciales, consulte Almacén de parámetros de Systems Manager y Tutorial: Crear y probar un parámetro de cadena de caracteres (consola) en la Guía del usuario de Amazon EC2 Systems Manager.

Obligatorio si se desea recuperar variables de entorno personalizadas almacenadas en AWS Secrets Manager. Especifique una reference-key de Secrets Manager utilizando el patrón siguiente:

<key>: <secret-id>:<json-key>:<version-stage>:<version-id>

En el ejemplo siguiente, TestSecret es el nombre del par clave-valor almacenado en Secrets Manager. La clave de TestSecret es MY_SECRET_VAR. Se accede a la variable durante la compilación utilizando el nombre de LOCAL_SECRET_VAR.

env:
  secrets-manager:
    LOCAL_SECRET_VAR: "TestSecret:MY_SECRET_VAR"

Para obtener más información, consulte ¿Qué es AWS Secrets Manager? en la Guía del usuario de AWS Secrets Manager.

Mapeo opcional. Se utiliza para enumerar las variables de entorno que desea exportar. Especifique el nombre de cada variable en la que desee exportar en una línea independiente exported-variables. La variable que desea exportar debe estar disponible en su contenedor durante la compilación. La variable exportada puede ser una variable de entorno.

Las variables de entorno exportadas se utilizan junto con AWS CodePipeline para exportar variables de entorno desde la fase de creación actual a las etapas siguientes del procesamiento. Para obtener más información, consulte Trabajar con variables en la Guía del usuario de AWS CodePipeline.

Durante una compilación, el valor de una variable está disponible a partir de la fase install. Se puede actualizar entre el inicio de la fase install y el final de la fase post_build. Una vez finalizada la fase post_build, el valor de las variables exportadas no puede cambiar.

Mapeo opcional. Se utiliza para indicar si CodeBuild utiliza su ayudante de credenciales de Git para proporcionar las credenciales de Git. yes si se utiliza. De lo contrario, seleccione no o sin especificar. Para obtener más información, consulte gitcredentials en el sitio web de Git.

Mapeo opcional. Establezca en yes si desea que la compilación de un servidor de proxy explícito cargue artefactos. El valor predeterminado es no.

Mapeo opcional. Se establece en yes para que la compilación de un servidor de proxy explícito cree Registros de CloudWatch. El valor predeterminado es no.

Secuencia opcional. Utilice una fase de compilación para especificar un usuario de Linux que ejecuta sus comandos. Si run-as también se especifica globalmente para todos los comandos en la parte superior del archivo buildspec, entonces el usuario de nivel de fase tiene prioridad. Por ejemplo, si run-as especifica globalmente User-1 y para la fase install solo una instrucción run-as especifica User-2, todos los comandos del archivo buildspec se ejecutan como User-1 excepto los comandos de la fase install, que se ejecutan como User-2.

Secuencia opcional. Especifica la acción que se debe realizar si se produce un error durante la fase. Puede ser uno de los valores siguientes:

Si no se especifica esta propiedad, el proceso de fallo sigue las fases de transición, como se muestra en Transiciones de fases de compilación.

Bloque opcional. Los comandos especificados en un bloque finally se ejecutan después de los del bloque commands. Los comandos de un bloque finally se aunque falle un comando del bloque commands. Por ejemplo, si el bloque commands contiene tres comandos y el primero produce un error, CodeBuild omite los dos comandos restantes y ejecuta los comandos del bloque finally. Se considera que la fase es satisfactoria cuando todos los comandos de los bloques commands y finally se ejecutan sin problemas. Si un comando de una fase falla, se considera que la fase falla.

Secuencia opcional. Representa los comandos, si los hay, que CodeBuild ejecuta durante la instalación. Le recomendamos que utilice la fase install únicamente para instalar paquetes en el entorno de compilación. Por ejemplo, puede utilizar esta fase para instalar una plataforma de comprobación de código como Mocha o RSpec.

Secuencia opcional. Representa los comandos, si hay alguno, que CodeBulild debe ejecutar antes de la compilación. Por ejemplo, puede utilizar esta fase para iniciar sesión en Amazon ECR o puede instalar dependencias npm.

Secuencia opcional. Representa los comandos, si los hay, que CodeBuild ejecuta durante la compilación. Por ejemplo, puede utilizar esta fase para ejecutar Mocha, RSpec o sbt.

Secuencia opcional. Representa los comandos, si los hay, que CodeBuild ejecuta después de la compilación. Por ejemplo, puede utilizar Maven para empaquetar los artefactos de la compilación en un archivo JAR o WAR, o puede remitir una imagen de Docker hacia Amazon ECR. A continuación, puede enviar una notificación de compilación a través de Amazon SNS.

Secuencia opcional. Especifica el grupo de informes al que se envían los informes. Un proyecto puede tener un máximo de cinco grupos de informes. Especifique el ARN de un grupo de informes existente o el nombre de un nuevo grupo de informes. Si se especifica un nombre, CodeBuild crea un grupo de informes utilizando el nombre del proyecto y el nombre especificado en el formato <project-name>-<report-group-name>. El nombre del grupo de informes también se puede establecer mediante una variable de entorno en la especificación de compilación, como $REPORT_GROUP_NAME. Para obtener más información, consulte Nomenclatura de grupos de informes.

Secuencia obligatoria. Representa las ubicaciones que contienen los datos sin procesar de los resultados de las pruebas generados por el informe. Contiene una secuencia de valores escalares, en la que cada valor representa una ubicación independiente donde CodeBulid puede encontrar los archivos de prueba, en relación con la ubicación de la compilación original o, si se ha establecido, el base-directory. Las ubicaciones pueden ser las siguientes:

Mapeo opcional. Representa el formato del archivo de informe. Si no se ha especificado, se utiliza JUNITXML. Este valor no distingue entre mayúsculas y minúsculas. Los valores posibles son los siguientes:

Mapeo opcional. Representa uno o más directorios de nivel superior, en relación con la ubicación de la compilación original, que CodeBuild utiliza para determinar dónde encontrar los archivos de prueba sin procesar.

Opcional. Especifica si los directorios del archivo de informes se aplanan en la salida. Si esto no se especifica o contiene no, los archivos de informes se generan con su estructura de directorios intacta. Si esto contiene yes, todos los archivos de prueba se colocan en el mismo directorio de salida. Por ejemplo, si una ruta a un resultado de prueba es com/myapp/mytests/TestResult.xml, especificar yes colocará este archivo en /TestResult.xml.

Secuencia obligatoria. Representa las ubicaciones que contienen los artefactos de salida de la compilación en el entorno de compilación. Contiene una secuencia de valores escalares, en la que cada valor representa una ubicación independiente donde CodeBuild puede encontrar artefactos de salida de la compilación en relación con la ubicación de la compilación original o, si se ha definido, el directorio base. Las ubicaciones pueden ser las siguientes:

AL especificar las ubicaciones de artefactos de salida de la compilación, CodeBuld puede encontrar la ubicación de la compilación original en el entorno de compilación. No tiene que anexar las ubicaciones de los artefactos de salida de la compilación a la ruta de acceso de la ubicación de la compilación original ni especificar ./ o similar. Si desea conocer la ruta a esta ubicación, puede ejecutar un comando como echo $CODEBUILD_SRC_DIR durante una compilación. La ubicación de cada entorno de compilación puede ser ligeramente diferente.

Nombre opcional. Especifica un nombre para su artefacto de compilación. Este nombre se utiliza cuando se cumple alguna de las condiciones siguientes.

Puede especificar un nombre en el archivo de especificación de compilación que se calcula en el momento de la compilación. El nombre especificado en un archivo de especificación utiliza el lenguaje de comandos Shell. Por ejemplo, puede adjuntar una fecha y una hora al nombre del artefacto para que siempre sea único. Los nombres de artefactos únicos impiden que los artefactos se sobrescriban. Para obtener más información, consulte Lenguaje de comandos Shell.

Puede añadir información sobre la ruta al nombre para que los artefactos nombrados se coloquen en directorios según la ruta que figure en el nombre. En este ejemplo, los artefactos de compilación se colocan en la salida dentro de builds/<build number>/my-artifacts.

version: 0.2
phases:
  build:
    commands:
      - rspec HelloWorld_spec.rb
artifacts:
  files:
    - '**/*'
  name: builds/$CODEBUILD_BUILD_NUMBER/my-artifacts

Opcional. Especifica si los directorios de artefactos de compilación se aplanan en la salida. Si esto no se especifica o contiene no, los artefactos de compilación se generan con su estructura de directorios intacta. Si esto contiene yes, todos los artefactos de compilación se colocan en el mismo directorio de salida. Por ejemplo, si una ruta a un archivo en el artefacto de salida de compilación es com/mycompany/app/HelloWorld.java, especificar yes colocará este archivo en /HelloWorld.java.

Mapeo opcional. Representa uno o más directorios de nivel superior, en relación con la ubicación de la compilación original, que CodeBuild usa para determinar qué archivos y subdirectorios debe incluir en el artefacto de salida de la compilación. Los valores válidos son:

Los directorios de nivel superior coincidentes no se incluyen en el artefacto de salida de la compilación, solo sus archivos y subdirectorios.

Puede utilizar files y discard-paths para restringir aún más los archivos y subdirectorios que se incluyen. Por ejemplo, para la siguiente estructura de directorios:

.
├── my-build-1
│   └── my-file-1.txt
└── my-build-2
    ├── my-file-2.txt
    └── my-subdirectory
        └── my-file-3.txt

Y para la siguiente secuencia artifacts:

artifacts:
  files:
    - '*/my-file-3.txt'
  base-directory: my-build-2

Se incluiría el siguiente subdirectorio y archivo en el artefacto de salida de la compilación:

.
└── my-subdirectory
    └── my-file-3.txt

Sin embargo, para la siguiente secuencia artifacts:

artifacts:
  files:
    - '**/*'
  base-directory: 'my-build*'
  discard-paths: yes

Se incluirían los siguientes archivos en el artefacto de salida de la compilación:

.
├── my-file-1.txt
├── my-file-2.txt
└── my-file-3.txt

Mapeo opcional. Representa una o más rutas relativas a base-directory que CodeBuild excluirá de los artefactos de compilación. El carácter asterisco (*) coincide con cero o varios caracteres de un componente de nombre sin superar límites de carpeta. Un asterisco doble (**) coincide con cero o más caracteres de un componente de nombre en todos los directorios.

A continuación, se muestran ejemplos de excude-path:

Opcional. Si el tipo de salida es ZIP, esto especifica si los enlaces simbólicos internos se conservan en el archivo ZIP. Si esto contieneyes, todos los enlaces simbólicos internos de la fuente se conservarán en el archivo ZIP de artefactos.

Opcional. Especifica un prefijo que se utiliza cuando los artefactos se envían a un bucket de Amazon S3 y el tipo de espacio de nombres es BUILD_ID. Cuando se usa, la ruta de salida del bucket es <s3-prefix>/<build-id>/<name>.zip.

Secuencia opcional. Representa una o varias definiciones de artefacto como mapeo entre un identificador de artefacto y una definición de este. Cada uno de los identificadores de artefacto de este bloque debe coincidir con un artefacto definido en el atributo secondaryArtifacts del proyecto. Todas las definiciones tienen la misma sintaxis que el bloque artifacts anterior.

Por ejemplo, si el proyecto tiene la estructura siguiente:

{
  "name": "sample-project",
  "secondaryArtifacts": [
    {
      "type": "S3",
      "location": "<output-bucket1>",
      "artifactIdentifier": "artifact1",
      "name": "secondary-artifact-name-1"
    },
    {
      "type": "S3",
      "location": "<output-bucket2>",
      "artifactIdentifier": "artifact2",
      "name": "secondary-artifact-name-2"
    }
  ]
}

El archivo buildspec tiene este aspecto:

version: 0.2

phases:
build:
  commands:
    - echo Building...
artifacts:
  files:
    - '**/*'
  secondary-artifacts:
    artifact1:
      files:
        - directory/file1
      name: secondary-artifact-name-1
    artifact2:
      files:
        - directory/file2
      name: secondary-artifact-name-2

Secuencia opcional. Representa la clave principal utilizada al buscar o restaurar una memoria caché. CodeBuild realiza una coincidencia exacta con la clave principal.

A continuación se muestra un ejemplo de la clave:

key: npm-key-$(codebuild-hash-files package-lock.json) }

Secuencia opcional. Representa una lista de claves de reserva que se utilizan secuencialmente cuando no se puede encontrar una caché con la clave principal. Se admiten hasta cinco claves de reserva y cada una de ellas se compara mediante una búsqueda por prefijo. Esta secuencia se ignorará si no se proporciona key.

A continuación se muestra un ejemplo de claves de reserva:

fallback-keys:
    - npm-key-$(codebuild-hash-files package-lock.json) }
    - npm-key-
    - npm-

Secuencia opcional. Especifica la acción que se va a realizar en la memoria caché. Los valores válidos son:

Si no se proporciona ningún valor, CodeBuild realiza de forma predeterminada la restauración y el almacenamiento.

Secuencia obligatoria. Representa las ubicaciones de la caché. Contiene una secuencia de valores escalares en la que cada valor representa una ubicación independiente donde CodeBuild puede encontrar artefactos de salida de la compilación en relación con la ubicación de la compilación original o, si se ha definido, el directorio base. Las ubicaciones pueden ser las siguientes: