Configure las reglas de PR Gate.
Descripción general
Para usar PR Gates en Datadog, defina una o más reglas en la página PR Gate Rules.
PR Gates garantizan que solo se fusionen los cambios de código que cumplan con sus estándares de seguridad y calidad.
Cree una regla
Para crear una regla de PR Gates en Datadog:
Vaya a Software Delivery > PR Gates > PR Gate Rules y haga clic en New Rule.
En Select your source, seleccione un tipo de regla:
- Static Code Analysis (SAST)
- Software Composition Analysis (SCA)
- Code Coverage
- Infrastructure as Code Scanning (IaC)
- Secret Scanning
- New Flaky Tests
En Define scope, establezca qué repositorios debe evaluar la regla:
- All repositories: La regla evalúa todos los repositorios configurados para el tipo de regla.
- Selected repositories: La regla evalúa solo los repositorios que usted especifique. Use
IN para incluir solo los repositorios especificados, o NOT IN para evaluar todos los repositorios configurados excepto los que usted especifique.
En Define condition, establezca las condiciones que harán que la regla falle. Cada tipo de regla tiene sus propias opciones de condición, y puede usar la configuración de condición predeterminada existente cuando selecciona un tipo de regla.
El siguiente ejemplo ilustra una regla de Análisis de código estático (SAST) que falla cuando una solicitud de extracción introduce al menos una violación de vulnerabilidad de código de Análisis de código estático con al menos una gravedad de Critical. La regla evalúa todos los repositorios configurados para el Análisis de código estático:
En Preview checks, seleccione su proveedor de gestión de código fuente para obtener una vista previa de la comprobación de estado que se agregará a las solicitudes de extracción. Para bloquear PR cuando una regla falla, siga las instrucciones de su proveedor para requerir que las PR Gates se aprueben antes de realizar la fusión (merge). En GitHub, Azure DevOps y Bitbucket Cloud, esto se hace configurando las comprobaciones de PR Gates como obligatorias. En GitLab, esto se hace configurando la cuenta de servicio de Datadog que creó al instalar la integración de fuente de GitLab como un aprobador obligatorio:
Las reglas que no bloquean pueden ser útiles cuando implementa una regla nueva y desea verificar su comportamiento antes de hacer que sea bloqueante.
Haga clic en Create Rule.
Se recomienda que pruebe su regla de PR Gate creando una nueva rama y un PR que introduzca a propósito cambios de código que violarían la condición de la regla. Tenga en cuenta que PR Gates no:
- Bloqueará retroactivamente los PR existentes a menos que se envíen nuevas confirmaciones (commits) a ellos después de que se haya creado la regla de PR Gate
- Bloqueará nuevos PR que no introduzcan violaciones como parte de sus líneas modificadas
Administrará las comprobaciones de PR
PR Gates crea automáticamente comprobaciones de PR en solicitudes de extracción (merge requests en GitLab) de GitHub, GitLab, Azure DevOps o Bitbucket Cloud para cada tipo de regla evaluado. La comprobación contiene información adicional sobre la evaluación de la regla, como el motivo del error y los eventos coincidentes en Datadog. En GitLab, PR Gates también utiliza una cuenta de servicio de Datadog para aprobar solicitudes de fusión cuando se cumplen todas las condiciones de sus reglas de PR Gate. La cuenta de servicio es la misma que creó cuando instaló la integración de fuente de GitLab.
Nota: Volver a ejecutar una comprobación en la interfaz de usuario de la solicitud de extracción no vuelve a ejecutar la regla de PR Gates correspondiente.
Para asegurarse de que PR Gates pueda crear comprobaciones de PR, debe instalar la integración para su proveedor de SCM. Si no tiene instalada la integración, siga la documentación de integración de GitHub, GitLab fuente, Azure DevOps fuente o Bitbucket Cloud fuente para configurar una.
Para Bitbucket Cloud, las comprobaciones solo se pueden configurar como bloqueantes si utiliza Bitbucket Cloud Premium.
Para que estas comprobaciones sean bloqueantes, deben establecerse como obligatorias en las políticas de rama de su proveedor de gestión de fuente (o la cuenta de servicio debe establecerse como aprobador obligatorio de sus MR en el caso de GitLab):
Administrar reglas
Puede editar o eliminar una regla de PR Gates pasando el cursor sobre ella en la lista PR Gates Rules y haciendo clic en el icono Edit o Delete.
Permisos
Solo los usuarios con el permiso quality_gate_rules_write pueden crear y editar reglas de PR Gate. Los usuarios con el permiso quality_gate_rules_read pueden visualizar las reglas de PR Gate.
Para obtener más información, consulte la documentación de permisos de RBAC.
Lecturas adicionales
Documentación, enlaces y artículos útiles adicionales: