ManualValidation@1 - Handmatige validatie v1-taak

Artikel
11/21/2024

Pauzeer een pijplijnuitvoering om te wachten op handmatige interactie. Werkt alleen met YAML-pijplijnen.

Syntaxis

# 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.

Ingangen

notifyUsers - gebruikers op de hoogte stellen
string. Vereist.

Verzend een handmatige validatie in behandeling zijnde e-mail naar een door komma's gescheiden lijst met specifieke gebruikers (of groepen). U kunt een e-mailbericht naar een groep verzenden met behulp van de syntaxis van de [org name]\group naam.

Deze taakinvoer is vereist, maar u kunt een lege tekenreeks opgeven als u niemand op de hoogte wilt stellen, bijvoorbeeld tijdens een testuitvoering: notifyUsers: ''.

approvers - goedkeurders
string.

Geef een door komma's gescheiden lijst met gebruikers/groepen/projectteams op om te reageren op een handmatige validatie. Als er geen invoer is, kunnen gebruikers met een machtiging voor wachtrijbuild actie ondernemen.

allowApproversToApproveTheirOwnRuns - Toestaan dat goedkeurders hun eigen uitvoering goedkeuren
boolean. Standaardwaarde: false.

Als dit waar is, kan fiatteur hun eigen uitvoering goedkeuren.

instructions - instructies
string.

Hiermee geeft u de instructies op die aan de gebruiker worden weergegeven bij het hervatten of weigeren van de handmatige validatie. Op basis van deze instructies neemt de gebruiker een weloverwogen beslissing over deze handmatige validatie.

onTimeout - bij time-out
string. Toegestane waarden: reject, resume. Standaardwaarde: reject.

Deze handmatige validatie wordt automatisch geweigerd of hervat nadat deze in behandeling is voor de opgegeven time-out of 30 dagen, afhankelijk van wat eerder is.

Opties voor taakbeheer

Alle taken hebben besturingsopties naast hun taakinvoer. Zie Opties en algemene taakeigenschappenvoor meer informatie.

Uitvoervariabelen

Geen.

Opmerkingen

Gebruik deze taak in een YAML-pijplijn om een uitvoering binnen een fase te onderbreken. Dit wordt meestal uitgevoerd om verschillende handmatige stappen of acties uit te voeren en vervolgens wordt de uitvoering hervat of geweigerd.

Belangrijk

Deze taak wordt alleen ondersteund in YAML-pijplijnen en kan alleen worden gebruikt in een taak zonder agent van een YAML-pijplijn.

Met de handmatige validatie taak kunt u een pijplijnuitvoering in een fase onderbreken, meestal om enkele handmatige stappen of acties uit te voeren en vervolgens door te gaan met de pijplijn. De gebruiker moet bijvoorbeeld handmatig bepaalde implementatieconfiguraties valideren voordat de pijplijn een langdurige rekenintensieve taak start.

De handmatige validatie taakconfiguratie bevat een instructies parameter die wordt gebruikt om gerelateerde informatie op te geven of om de handmatige stappen op te geven die de gebruiker tijdens de pauze uitvoert. U kunt de taak configureren voor het verzenden van e-mailmeldingen naar gebruikers en gebruikersgroepen wanneer deze wacht op een beoordeling en het automatische antwoord (weigeren of hervatten) opgeeft nadat er een configureerbare time-out is opgetreden.

U kunt de time-outwaarde voor de taak opgeven met behulp van de optionele parameter timeoutInMinutes, beschikbaar in de algemene taakeigenschappen.

Notitie

Om de taak volledig uit te voeren, moet de timeoutInMinutes waarde van de taak (default = 60 minutes) die deze taak bevat, hoger zijn dan de timeoutInMinutes waarde van de taak zelf. Zie standaardwaarden voor taaktime-outs.

Fooi

U kunt variabelen gebruiken om e-mailadressen op te geven in de parameter notifyUsers.

Wanneer de taak Handmatige validatie wordt geactiveerd tijdens een pijplijn, wordt er een berichtenbalk weergegeven met een koppeling waarmee het dialoogvenster Handmatige validatie wordt geopend. Deze bevat de instructies. Nadat de handmatige stappen zijn uitgevoerd, kan de beheerder of gebruiker ervoor kiezen om de uitvoering te hervatten of te weigeren. Gebruikers met Queue-builds machtiging voor de pijplijn kunnen de uitvoering hervatten of weigeren.

Voorbeelden

  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'

In dit voorbeeld wordt timeoutInMinutes gebruikt. Dit is een algemene taakeigenschap beschikbaar in alle taken.

Eisen

Eis	Beschrijving
Pijplijntypen	YAML, klassieke build
Wordt uitgevoerd op	Server
eisen	Geen
mogelijkheden	Deze taak voldoet niet aan de vereisten voor volgende taken in de taak.
opdrachtbeperkingen	Enig
variabelen instellen	Enig
Agentversie	Alle ondersteunde agentversies.
Taakcategorie	Implementeren

Delen via