Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

runbook-run subcommand #165

Open
jbristowe opened this issue Dec 6, 2022 · 2 comments
Open

runbook-run subcommand #165

jbristowe opened this issue Dec 6, 2022 · 2 comments

Comments

@jbristowe
Copy link
Contributor

jbristowe commented Dec 6, 2022

OctopusDeploy/OctopusCLI#243

We are considering adding a set of commands that will allow users to list, view, and delete runs of runbooks. This is done to perform administrative operations against Octopus. Unfortunately, this request poses a naming challenge; how do we represent runbook runs? A runbook run is a historical artefact in the context of Octopus. However, it's also refers to an action associated with a runbook (i.e. "the runbook ran to update the server"). It's confusing.

I propose the establishment of a runbook-run subcommand:

$ octopus runbook-run [command]

This subcommand would allow you to delete, list, and view runbook runs; runbooks that executed in the past.

In summary, the revised list of runbook-related commands would be:

$ octopus runbook delete       # deletes a runbook
$ octopus runbook execute      # executes a runbook
$ octopus runbook list         # lists runbooks
$ octopus runbook-run delete   # deletes a runbook run
$ octopus runbook-run list     # lists runbook runs
$ octopus runbook-run view     # views a runbook run
$ octopus runbook view         # view a runbook
@jbristowe jbristowe changed the title runbook run subcommand runbook-run subcommand Dec 7, 2022
@benPearce1
Copy link
Contributor

Further support for this work OctopusDeploy/OctopusCLI#244

@toby-freemarket
Copy link

the ability to publish a snapshot is missing
https://octopus.com/docs/octopus-rest-api/examples/runbooks/create-and-publish-runbook

$ octopus runbook snapshot    #create a runbook snapshot

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants