From f63a8400aaaf747ed4be02091f4b6849ee0ad2f8 Mon Sep 17 00:00:00 2001 From: CaitlynStocker Date: Fri, 8 Nov 2024 14:29:37 +1000 Subject: [PATCH] Draft done --- .../docs/runbooks/config-as-code-runbooks.md | 21 +++++++------------ 1 file changed, 8 insertions(+), 13 deletions(-) diff --git a/src/pages/docs/runbooks/config-as-code-runbooks.md b/src/pages/docs/runbooks/config-as-code-runbooks.md index 72d0628fc..82d093041 100644 --- a/src/pages/docs/runbooks/config-as-code-runbooks.md +++ b/src/pages/docs/runbooks/config-as-code-runbooks.md @@ -60,26 +60,21 @@ Octopus provides two built in roles to help you to manage permissions around edi - Non-CaC Runbooks - can edit and run both draft and published runbooks. - CaC Runbooks - can edit runbooks on any unprotected branches and can run runbooks from any commit on any branch. -Effectively, this means that your 'published' runbooks will become those in the latest commit on your default branch, and your 'draft' runbooks are those on any other commit and any other branch. +Effectively, this means that your old 'published' runbooks will become those in the latest commit on your default branch, and your 'draft' runbooks will become those on any other commit and any other branch. 💡 If you are using Octopus built in roles, keep these permissions in mind when moving your draft runbooks out of the 'migrated-drafts/' folder. ## Snapshots vs commits +Another exciting thing about CaC Runbooks is that every revision to your runbook process, settings and variables is captured in your commit history. This means that you can now re-run any previous version of your runbook without the need for snapshots. -## How are runbooks different with CaC? +To run-run an old CaC Runbook, simply enter the commit has on the branch selector at the **Runbooks** page and run the runbook. If you are using the Octopus built in roles, this will require the Runbook Producer role. -- branching allows you to edit as many copies of your runbook as you have branches - this replaces the need for published and draft runbooks -- commit history allows you to run previous runbooks from any stage in your commit history - this replaces the need for snapshots -- package versions can be fixed in steps rather than snapshots +The information previously found on the **Snapshot** page is still available on the **Details** tab of each runbook run. -- Other branches - replaces draft snapshots - - give you a place to work and save a runbook that is a work in progress or has not yet been approved for general use. - - equivalent of a draft runbook - - non-default branch runbooks can’t be used to create a scheduled runbook trigger, only published snapshots can. +💡 If you were previously freezing package versions in your snapshots, you can now specify fixed package versions inside your runbook steps. -- Default branch - replaces published snapshots - - think of it as the “Production” ready version of the runbook, which has been approved for general use. - - equivalent of a published runbook - - makes a runbook available to scheduled triggers and consumers (anyone with an appropriately scoped RunbookRunCreate permission, but without the RunbookEdit permission). Triggers and consumers will always execute from the default branch. +## Scheduled triggers + +Runbook triggers will always run CaC Runbooks from the latest commit on your default branch, just as non-CaC runbook triggers will only run published runbooks.