Skip to content
Release: Australia · Updated: 2026-03-12 · Official documentation · View source

Create a runbook task

Create a runbook task to pause deployment and define the steps required to proceed.

Before you begin

Role required: sn_releaseops.releaseops_tester or sn_releaseops.releaseops_developer

About this task

Runbook tasks enable you to pause playbook progress until a task is resolved. To learn more about runbook tasks, see Runbook tasks in ReleaseOps.

Procedure

  1. On a deployment request record, select the Deployment request tasks tab in the Related lists section.
Image omitted: releaseops-deployment-request-task-tab.png
Select the Deployment request tasks tab.
  1. Select New.

  2. On the new deployment task record, select the playbook where you want the runbook task to occur.

    1. In the Pipeline stage field, select the dropdown menu.
Image omitted: releaseops-runbook-task-pipeline-stage.png
Select the playbook where you want the runbook task to occur.
2.  Select the playbook that you want the runbook task to occur in, either assessment or release.
  1. Select the playbook stage where you want the runbook task to occur.

    1. In the Playbook stage field, enter the name of the playbook stage or find the available playbook stages using the lookup using list icon.

    2. Select the playbook stage.

  2. Define when you want the runbook task to occur, either at the beginning or end of the selected playbook stage.

    1. In the Wait for runbook activity field, select the Lookup using list icon
Image omitted: lookup-using-list-icon.png
.
    A dialog appears that displays the selected playbook stage and the options available for when the runbook task can occur.
Image omitted: releaseops-wait-for-runbook-activity-dialog.png
For the selected playbook stage, a dialog appears that shows the options for when the runbook task can occur.
2.  In the dialog, select either **Before** the playbook stage or **After** the playbook stage.
  1. In the Short description field, describe the runbook activity that must occur.
Image omitted: releaseops-runbook-task-short-desc-v1.png
In the Short description field, describe the runbook task.
  1. Select Submit.

Result

The runbook task is added to the playbook stage that you selected. When the playbook is executed, progress will stop until the runbook task is completed.

Parent Topic:Using ReleaseOps to manage deployments