Manual approval

2 minute read

Use this job to request a workflow approval from users and teams. Refer to Manage workflows for more information.

All CloudBees custom job repositories are listed at CloudBees, Inc. on GitHub.

Inputs

Table 1. Input details
Input name Data type Required? Description

approvers

String

No

A list of users whose participation in the workflow approval process is requested. The approvers field supports both user IDs and email addresses.

delegates

String

Yes

The value must be the path to the Manual approval custom job yaml file: cloudbees-io/manual-approval/custom-job.yml@v1

disallowLaunchByUser

String

No

When set to true, it prevents the user who started the workflow from participating in the approval. Default value is false.

instructions

String

Yes

Use to add instructions for approvers. This text will appear:

  • In the approval response request email notification.

  • On workflow run details screen.

notifyAllEligibleUsers

String

No

Use to notify all users who have the execute approval permission on the workflow when no approvers are listed by selecting Notify all eligible users. Default value is false.

Notifications will be sent as follows:

  • If users are listed in Approvers and Notify all eligible users is true or false, then

    • Only listed approvers will receive notification.

    • Only listed approvers can participate in approval process.

  • If Approvers is blank and Notify all eligible users is false, then

    • No notifications will be sent.

    • All eligible users can participate in approval process.

  • If Approvers is blank and Notify all eligible users is true, then

    • The CloudBees platform will select and notify up to 10 eligible users.

    • All eligible users can participate in approval process.

timeout-minutes

Integer

No

The amount of time approvers have to respond to the approval request. The default value is 4320 minutes (three days).

Usage example

In your YAML file, add:

workflow-approval-name: timeout-minutes: 4320 delegates: cloudbees-io/manual-approval/custom-job.yml@v1 with: approvers: notifyAllEligibleUsers: false instructions: "Enter instructive text for approvers here. "