Skip to content

feat: add Run runbook step - #229

Merged
NickJosevski merged 1 commit into
mainfrom
feat/178-run-runbook-step
Aug 20, 2026
Merged

feat: add Run runbook step#229
NickJosevski merged 1 commit into
mainfrom
feat/178-run-runbook-step

Conversation

@NickJosevski

@NickJosevski NickJosevski commented Aug 12, 2026

Copy link
Copy Markdown
Contributor

Closes #178

The plugin can create, deploy and promote releases, but there is no way to run a runbook from a TeamCity build. Both the legacy octo and the new octopus CLI already support it.

This PR:

  • Adds an "OctopusDeploy: Run runbook" step with project, runbook, environment(s), and — under advanced — tenants, tenant tags and snapshot, plus the usual wait / timeout / cancel-on-timeout options
  • Implements both agent paths, matching Deploy release: octo run-runbook by default, and octopus runbook run followed by task wait when the new CLI is selected
  • Registers the runner type as connection-aware so connections supply the server URL and API key
  • Adds validation, agent command and e2e tests, and includes the new form in the connection-form smoke test

Verified end to end against real containers (TeamCity 2025.03.3, Octopus 2025.4) and against Octopus 2026.2 (locally): the step runs a runbook and waits for it, and the run shows up in Octopus. Covered both the published snapshot and an explicitly named one. Both CLIs' flags were checked against a local Octopus first.

@github-actions github-actions Bot added the feat label Aug 12, 2026
@NickJosevski
NickJosevski force-pushed the feat/178-run-runbook-step branch from 43cc7bc to 67bc7c4 Compare August 13, 2026 03:19
@NickJosevski
NickJosevski force-pushed the feat/178-run-runbook-step branch 2 times, most recently from ae45237 to d6d0d1d Compare August 18, 2026 05:25
@NickJosevski
NickJosevski marked this pull request as ready for review August 19, 2026 02:17
Adds an "OctopusDeploy: Run runbook" build step so a TeamCity build can run
an Octopus runbook, closing the gap where only releases could be deployed.

Closes #178

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@NickJosevski
NickJosevski force-pushed the feat/178-run-runbook-step branch from d6d0d1d to c2b25da Compare August 20, 2026 00:46
@NickJosevski
NickJosevski merged commit c4a70af into main Aug 20, 2026
6 checks passed
@NickJosevski
NickJosevski deleted the feat/178-run-runbook-step branch August 20, 2026 04:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add Runbook support

2 participants