Skip to content

Commit af66b6b

Browse files
authored
chore(docs): update config as code runbooks to include a section on custom scripts after conversion (#2623)
1 parent 212f1b5 commit af66b6b

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

src/pages/docs/runbooks/config-as-code-runbooks.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,3 +82,8 @@ The information that was previously found on the **Snapshot** page is still avai
8282

8383
[Runbook triggers](/docs/runbooks/scheduled-runbook-trigger) will always run CaC Runbooks from the latest commit on your default branch, just as non-CaC runbook triggers will only run published runbooks.
8484

85+
## Custom automated scripts
86+
87+
If you use automated scripts that run runbooks via the Octopus Server API and you convert your runbooks to Config As Code the URL for the runbook will change to include a branch reference (e.g. `refs/heads/main`) as a result you need to update your scripts to include the branch reference where the runbook is stored.
88+
89+
- [PowerShell example](https://github.com/OctopusDeploy/OctopusDeploy-Api/blob/master/REST/PowerShell/Runbooks/RunConfigAsCodeRunbook.ps1)

0 commit comments

Comments
 (0)