ManualValidation@1: tarea validación manual v1

Artículo
11/21/2024

Pausar una ejecución de canalización para esperar la interacción manual. Solo funciona con canalizaciones YAML.

Sintaxis

# Manual validation v1
# Pause a pipeline run to wait for manual interaction. Works only with YAML pipelines.
- task: ManualValidation@1
  inputs:
    notifyUsers: # string. Required. Notify users. 
    #approvers: # string. Approvers. 
    #allowApproversToApproveTheirOwnRuns: false # boolean. Allow approvers to approve their own run. Default: false.
    #instructions: # string. Instructions. 
    #onTimeout: 'reject' # 'reject' | 'resume'. On timeout. Default: reject.

Entradas

notifyUsers - Notificar a los usuarios
string. Obligatorio.

Envíe un correo electrónico pendiente de validación manual a una lista separada por comas de usuarios específicos (o grupos). Puede enviar un correo electrónico a un grupo mediante la sintaxis de nombre [org name]\group.

Esta entrada de tarea es necesaria, pero puede especificar una cadena vacía si no desea notificar a nadie, por ejemplo, durante una ejecución de prueba: notifyUsers: ''.

approvers - aprobadores
string.

Especifique una lista separada por comas de usuarios, grupos o equipos de proyecto para actuar en una validación manual. En ausencia de entrada, los usuarios con permiso de compilación de cola podrán tomar medidas.

allowApproversToApproveTheirOwnRuns - Permitir que los aprobadores aprueben su propio de ejecución
boolean. Valor predeterminado: false.

Si esto es cierto, el aprobador podrá aprobar su propia ejecución.

instructions - instrucciones
string.

Especifica las instrucciones que se muestran al usuario al reanudar o rechazar la validación manual. En función de estas instrucciones, el usuario tomará una decisión informada sobre esta validación manual.

onTimeout - al tiempo de espera
string. Valores permitidos: reject, resume. Valor predeterminado: reject.

Rechaza o reanuda automáticamente esta validación manual después de que esté pendiente para el tiempo de espera especificado, o 30 días, lo que sea anterior.

Opciones de control de tareas

Todas las tareas tienen opciones de control además de sus entradas de tarea. Para obtener más información, consulte Opciones de control y propiedades de tareas comunes.

Variables de salida

Ninguno.

Observaciones

Use esta tarea en una canalización DE YAML para pausar una ejecución dentro de una fase. Normalmente se ejecuta para realizar varios pasos o acciones manuales y, a continuación, la ejecución se reanuda o rechaza.

Importante

Esta tarea solo se admite en canalizaciones YAML y solo se puede usar en un trabajo sin agente de una canalización YAML.

La tarea validación manual permite pausar una ejecución de canalización dentro de una fase, normalmente para realizar algunos pasos o acciones manuales y, a continuación, continuar con la canalización. Por ejemplo, es posible que el usuario tenga que validar manualmente determinadas configuraciones de implementación antes de que la canalización inicie un trabajo intensivo de cálculo de larga duración.

La configuración de la tarea validación manual incluye una instrucciones parámetro que se usa para proporcionar información relacionada o para especificar los pasos manuales que ejecuta el usuario durante la pausa. Puede configurar la tarea para enviar notificaciones por correo electrónico a usuarios y grupos de usuarios cuando está esperando una revisión y especificar la respuesta automática (rechazar o reanudar) después de que se produzca un tiempo de espera configurable.

Puede especificar el valor de tiempo de espera de la tarea mediante el parámetro opcional timeoutInMinutes, disponible en las propiedades de tarea comunes .

Nota

Para que la tarea se ejecute completamente, el valor timeoutInMinutes del trabajo (default = 60 minutes) que contiene esta tarea debe ser mayor que el valor timeoutInMinutes de la propia tarea. Consulte valores de tiempo de espera de trabajo predeterminados.

Propina

Puede usar variables para especificar direcciones de correo electrónico en el parámetro notifyUsers.

Cuando la tarea Validación manual se activa durante una canalización, muestra una barra de mensajes con un vínculo que abre el cuadro de diálogo Validación manual, que contiene las instrucciones. Después de llevar a cabo los pasos manuales, el administrador o el usuario pueden optar por reanudar la ejecución o rechazarla. Los usuarios con Queue compila permiso en la canalización pueden reanudar o rechazar la ejecución.

Ejemplos

  jobs:
  - job: waitForValidation
    displayName: Wait for external validation
    pool: server
    timeoutInMinutes: 4320 # job times out in 3 days
    steps:
    - task: ManualValidation@1
      timeoutInMinutes: 1440 # task times out in 1 day
      inputs:
        notifyUsers: |
          test@test.com,
          example@example.com
        instructions: 'Please validate the build configuration and resume'
        onTimeout: 'resume'

En este ejemplo se usa timeoutInMinutes que es una propiedad de tarea común disponible en todas las tareas.

Requisitos

Requisito	Descripción
Tipos de canalización	YAML, compilación clásica
Se ejecuta en	Servidor
demandas	Ninguno
funcionalidades de	Esta tarea no satisface ninguna demanda de tareas posteriores en el trabajo.
restricciones de comandos	Cualquier
variables settable	Cualquier
Versión del agente	Todas las versiones de agente admitidas.
Categoría de tarea	Desplegar

Compartir a través de