Ejemplo de creación de insignias con CodeBuild

AWS CodeBuild ahora admite el uso de insignias de compilación, que proporcionan una imagen incrustable generada dinámicamente (insignia) que muestra el estado de la última compilación de un proyecto. Se puede acceder a esta imagen a través de una URL disponible públicamente generada para su CodeBuild proyecto. Esto permite que cualquier persona pueda 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. Abra laAWS CodeBuild consola en https://console.aws.amazon.com/codesuite/codebuild/home.

2. Si aparece una página de CodeBuild información, seleccione Crear proyecto de construcción. De lo contrario, en el panel de navegación, expanda Crear, elija Crear proyectos y, a continuación, elija Crear proyecto de creació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 debe ser únicos en cada cuenta de AWS. También puedes incluir una descripción opcional del proyecto de compilación para ayudar a otros usuarios a entender para qué se utiliza este 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 fuente de Amazon S3. Dado queAWS CodePipeline utiliza Amazon S3 para la transferencia de artefactos, las insignias de compilación no son compatibles con los proyectos de compilación que formen parte de una canalización creada en CodePipeline.

   • Si eligió CodeCommit, en Repository (Repositorio), elija el nombre del repositorio. Seleccione Enable build badge (Habilitar insignia de compilación) para convertir el estado de compilación del proyecto en visible e incrustable.

   • Si lo deseas GitHub, sigue las instrucciones para conectarte (o volver a conectarte) con GitHub. En la página GitHub Autorizar la aplicación, en Acceso a la organización, selecciona Solicitar acceso juntoAWS CodeBuild a cada repositorio 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 Enable build badge (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. Después de elegir Grant access (Conceder acceso), de vuelta en la consola de AWS CodeBuild, para Repository (Repositorio), elija el nombre del repositorio que contiene el código fuente. Seleccione Enable build badge (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 administrada por AWS CodeBuild, elija Managed image (Imagen administrada) y después elija una opción en Operating system (Sistema operativo), Runtime (Tiempo de ejecución), Image (Imagen) e Image version (Versión de 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). Para el tipo de entorno, elija ARM, Linux, GPU Linux o Windows. Si elige Other registry (Otro registro), para External registry URL (URL de registro externo), introduzca el nombre y etiqueta de la imagen de Docker en Docker Hub, usando el formato docker repository/docker image name. Si elige Amazon ECR, utilice el repositorio de Amazon ECR y la imagen de Amazon ECR para elegir la imagen de Docker en suAWS cuenta.

   • Para usar una imagen privada de Docker, selecciona Imagen personalizada. Para el tipo de entorno, elija ARM, Linux, GPU Linux o Windows. En Image registry (Registro de imagen), elija Other registry (Otro registro) y, a continuación, introduzca el ARN de las credenciales para su imagen de Docker privada. Secrets Manager debe crear las credenciales. Para obtener más información, consulte ¿Qué es 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 CodeBuild de 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 Función de servicio existente. En Role ARN, elija el rol de servicio.

   nota

   Cuando utiliza la consola de para crear o actualizar un proyecto de compilación, puede 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 Buildspec, lleve a cabo una de las siguientes operaciones:

   • Elija Usar un archivo buildspec para usar el archivo buildspec.yml 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 el resultado de la compilación en un bucket de S3, elija Amazon S3 y, a continuación, haga lo siguiente:

     • Si desea utilizar su nombre de proyecto para el archivo ZIP o carpeta de salida de la compilación, deje en blanco Name (Nombre). 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 desea producir un archivo ZIP, incluya la extensión zip.

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

     • Si eligió Insert build commands (Insertar comandos de compilación) anteriormente en este procedimiento, en Output files (Archivos de salida), escriba las ubicaciones de los archivos de la compilación que desea incluir en el archivo ZIP 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 Create build project (Crear proyecto de compilación). En la página Review (Revisar), elija Start build (Comenzar compilación) para ejecutar la compilación.

Creación de un proyecto de compilación con 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 compilación con su proyecto de AWS CodeBuild, debe especificar badgeEnabled con un valor de true.

Acceso a las insignias de compilación de AWS CodeBuild

Puede utilizar la consola de AWS CodeBuild o la AWS CLI para obtener acceso a las insignias de compilación.

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

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

La URL de solicitud de insignia de compilación 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 puede especificar una etiqueta de su repositorio de origen sustituyendo elbranch parámetro por el parámetro de latag URL de la insignia. 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 compilación en un archivo de Markdown utilizando la URL de tu insignia de compilación en una imagen de Markdown. Esto es útil para mostrar el estado de la compilación más reciente en el archivo readme.md del repositorio de origen (por ejemplo, GitHub o CodeCommit). Por ejemplo:

![](<build badge URL>)

CodeBuild estados de las insignias

• PASSING La compilación más reciente en la ramificación especificada se ha realizado correctamente.

• FAILING Se ha agotado el tiempo de espera, se ha producido un error o se ha detenido la compilación más reciente en la ramificación especificada.

• IN_PROGRESS La compilación más reciente en la ramificación especificada está en curso.

• UNKNOWN El proyecto aún no ha ejecutado una compilación en la ramificación especificada o en ninguna otra. Además, la característica de insignia de compilación podría estar deshabilitada.