Crea una muestra de insignias con CodeBuild

AWS CodeBuild ahora admite el uso de insignias de compilación, que proporcionan una imagen (insignia) integrable y generada dinámicamente que muestra el estado de la última compilación de un proyecto. Se puede acceder a esta imagen a través de una imagen disponible públicamente URL generada para su proyecto. CodeBuild Esto permite a cualquier persona ver el estado de un CodeBuild proyecto. Las insignias de compilación no contienen información de seguridad, por lo que no requieren autenticación.

Creación de un proyecto de compilación con insignias de compilación habilitadas (consola)

1. Abre la AWS CodeBuild consola en https://console.aws.amazon.com/codesuite/codebuild/home.

2. Si se muestra una página de CodeBuild información, elija Crear proyecto de compilación. De lo contrario, en el panel de navegación, expanda Compilar, elija Proyectos de compilación y, a continuación, elija Crear proyecto de compilación.

3. En Project name (Nombre de proyecto), escriba un nombre para este proyecto de compilación. Los nombres de los proyectos de compilación deben ser únicos en cada AWS cuenta. También puede introducir una descripción opcional del proyecto de compilación para ayudar a otros usuarios a entender para qué se utiliza el proyecto.

4. En Source (Código fuente), para Source provider (Proveedor de código fuente), elija el tipo de proveedor de código fuente y, a continuación, realice alguna de las siguientes operaciones:

   nota

   CodeBuild no admite insignias de compilación con el proveedor de código fuente de Amazon S3. Como AWS CodePipeline utiliza Amazon S3 para las transferencias de artefactos, las insignias de compilación no se admiten en proyectos de compilación que formen parte de una canalización creada en. CodePipeline

   • Si lo ha elegido CodeCommit, en Repositorio, elija el nombre del repositorio. Seleccione Habilitar insignia de compilación para convertir el estado de compilación del proyecto en visible e incrustable.

   • Si lo desea GitHub, siga las instrucciones para conectarse (o volver a conectarse) con GitHub. En la página GitHub Autorizar la solicitud, en Acceso a la organización, selecciona Solicitar acceso junto a cada repositorio AWS CodeBuild al que quieras acceder. Después de elegir Authorize application (Autorizar aplicación), de vuelta en la consola de AWS CodeBuild , para Repository (Repositorio), elija el nombre del repositorio que contiene el código fuente. Seleccione Habilitar insignia de compilación para convertir el estado de compilación del proyecto en visible e incrustable.

   • Si eligió Bitbucket, siga las instrucciones para conectarse (o volver a conectarse) a Bitbucket. En la página Confirm access to your account de Bitbucket, para Organization access, elija Grant access. Tras seleccionar Conceder acceso, en la AWS CodeBuild consola, en Repositorio, elige el nombre del repositorio que contiene el código fuente. Seleccione Habilitar insignia de compilación para convertir el estado de compilación del proyecto en visible e incrustable.

     importante

     La actualización del código fuente del proyecto podría afectar a la precisión de las insignias de compilación del proyecto.

5. En Environment (Entorno):

   En Environment image (Imagen del entorno), realice alguna de las siguientes operaciones:

   • Para usar una imagen de Docker gestionada por AWS CodeBuild, selecciona Imagen gestionada y, a continuación, selecciona Sistema operativo, Tiempo de ejecución, Imagen y Versión de la imagen. Realice una selección en Environment type (Tipo de entorno) si está disponible.

   • Para usar otra imagen de Docker, elija Custom image (Imagen personalizada). En el tipo de entorno ARM, elija LinuxGPU, Linux o Windows. Si elige Otro registro, en Registro externo URL, introduzca el nombre y la etiqueta de la imagen de Docker en Docker Hub, utilizando el formato. docker repository/docker image name Si eliges Amazon ECR, usa el ECRrepositorio de Amazon y la ECRimagen de Amazon para elegir la imagen de Docker en tu AWS cuenta.

   • Para usar una imagen de Docker privada, elija Imagen personalizada. En el tipo de entorno ARM, elige LinuxGPU, Linux o Windows. En Registro de imágenes, selecciona Otro registro y, a continuación, introduce las credenciales ARN de tu imagen privada de Docker. Es necesario crear las credenciales con Secrets Manager. Para obtener más información, consulte AWS Secrets Manager en la Guía del usuario de AWS Secrets Manager .

6. En Service role (Rol de servicio), realice una de las operaciones siguientes:

   • Si no tiene un rol de CodeBuild servicio, elija Nuevo rol de servicio. Escriba un nombre para el nuevo rol en el campo Role Name.

   • Si tiene un rol CodeBuild de servicio, elija el rol de servicio existente. En Función ARN, elija la función de servicio.

   nota

   Cuando utilizas la consola para crear o actualizar un proyecto de compilación, puedes crear un rol de CodeBuild servicio al mismo tiempo. De forma predeterminada, el rol funciona solamente con ese proyecto de compilación. Si utiliza la consola para asociar este rol de servicio a otro proyecto de compilación, el rol se actualizará para que funcione con el otro proyecto de compilación. Un rol de servicio puede funcionar con hasta diez proyectos de compilación.

7. En Archivo de especificación de compilación, realice alguna de las operaciones siguientes:

   • Seleccione Usar un archivo de especificaciones de compilación para utilizar el archivo buyildspec.yml que figura en el directorio raíz del código fuente.

   • Elija Insertar comandos de compilación para usar la consola para insertar comandos de compilación.

   Para obtener más información, consulte Referencia de la especificación de compilación.

8. En Artifacts (Artefactos), en Type (Tipo), realice una de las siguientes operaciones:

   • Si no desea crear ningún artefacto de salida de la compilación, elija No artifacts (Sin artefactos).

   • Para almacenar la salida de la compilación en un bucket de S3, seleccione Amazon S3 y, a continuación, haga lo siguiente:

     • Si quieres usar el nombre de tu proyecto como ZIP archivo o carpeta de salida de la compilación, deja el campo Nombre en blanco. De lo contrario, escriba el nombre. De forma predeterminada, el nombre del artefacto es el nombre del proyecto. Si desea usar otro nombre, escríbalo en el cuadro de nombre de artefactos. Si quieres generar un ZIP archivo, incluye la extensión zip.

     • En Bucket name (Nombre del bucket), seleccione el nombre del bucket de salida.

     • Si eligió Insertar comandos de compilación al principio de este procedimiento, en Archivos de salida, introduzca las ubicaciones de los archivos de la compilación que desee colocar en el ZIP archivo o carpeta de salida de la compilación. Si hay varias ubicaciones, separe cada una de las ubicaciones con una coma (por ejemplo, appspec.yml, target/my-app.jar). Para obtener más información, consulte la descripción de files en Sintaxis de buildspec.

9. Expanda Additional configuration (Configuración adicional) y elija las opciones que correspondan.

10. Elija Crear el proyecto de compilación. En la página Review (Revisar), elija Start build (Comenzar compilación) para ejecutar la compilación.

Cree un proyecto de compilación con las insignias de compilación habilitadas () CLI

Para obtener información acerca de cómo crear un proyecto de compilación, consulte Crear un proyecto de compilación (AWS CLI). Para incluir insignias de construcción en tu AWS CodeBuild proyecto, debes especificar badgeEnabled con un valor de. true

Accede a tus insignias de AWS CodeBuild construcción

Puedes usar la AWS CodeBuild consola o la AWS CLI para acceder a las insignias de construcción.

• En la CodeBuild consola, en la lista de proyectos de construcción, en la columna Nombre, elija el enlace que corresponda al proyecto de construcción. En el proyecto de compilación: project-nameEn la página Configuración, seleccione Copiar insignia URL. Para obtener más información, consulte Ver los detalles de un proyecto de compilación (consola).

• En AWS CLI, ejecute el batch-get-projects comando. El distintivo de construcción URL se incluye en la sección de detalles del entorno del proyecto de la salida. Para obtener más información, consulte Ver los detalles de un proyecto de compilación (AWS CLI).

La solicitud de insignia de compilación URL se genera con una rama predeterminada común, pero puedes especificar cualquier rama del repositorio de origen que hayas utilizado para ejecutar una compilación. Por ejemplo:

https://codebuild.us-east-1.amazon.com/badges?uuid=...&branch=<branch>

También puedes especificar una etiqueta de tu repositorio de origen sustituyendo el branch parámetro por el tag parámetro de la insigniaURL. Por ejemplo:

https://codebuild.us-east-1.amazon.com/badges?uuid=...&tag=<tag>

Publica tus insignias de CodeBuild construcción

Puedes mostrar el estado de la última versión en un archivo de Markdown utilizando tu insignia de compilación URL en una imagen de Markdown. Esto resulta útil para mostrar el estado de la compilación más reciente del archivo readme.md del repositorio de código fuente (por ejemplo, o). GitHub CodeCommit Por ejemplo:

![](<build badge URL>)

CodeBuild estados de insignias

• PASSINGSe aprobó la versión más reciente de la sucursal en cuestión.

• FAILINGLa compilación más reciente de la rama en cuestión agotó el tiempo de espera, falló, falló o se detuvo.

• IN_ PROGRESS La compilación más reciente de la rama en cuestión está en curso.

• UNKNOWNEl proyecto aún no ha realizado ninguna compilación para la sucursal en cuestión o no ha realizado ninguna versión. Además, la característica de insignia de compilación podría estar deshabilitada.