Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 61 additions & 0 deletions src/pages/docs/cli/_generated/octopus-release-promote.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
---
layout: src/layouts/Cli.astro
pubDate: 2023-01-01
modDate: 2026-10-16
title: octopus release promote
description: Promote a release
navOrder: 128
---
import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md';

Promote a release to a specific environment

```text
Usage:
octopus release promote [flags]

Flags:
--deploy-at string Deploy at a later time. Deploy now if omitted. TODO date formats and timezones!
--deploy-at-expiry string Cancel the deployment if it hasn't started within this time period.
--deployment-freeze-name stringArray Override this deployment freeze (can be specified multiple times)
--deployment-freeze-override-reason string Reason for overriding a deployment freeze
--deployment-target stringArray Deploy to this target (can be specified multiple times)
--exclude-deployment-target stringArray Deploy to targets except for this (can be specified multiple times)
--excluded-target-tag stringArray Deploy to targets except for those matching this tag (can be specified multiple times)
--force-package-download Force re-download of packages
--from string Name or ID of the environment to get the current deployment from
--guided-failure string Enable Guided failure mode (true/false/default)
--latest-successful Use the latest successful release to promote
--priority string Jump the task queue ahead of other queued tasks (true/false/default). Requires the Priority Tasks feature, and the TaskPrioritize permission to set true.
-p, --project string Name or ID of the project
--skip stringArray Exclude specific steps from the deployment
--specific-target-tag stringArray Deploy to targets matching this tag (can be specified multiple times)
--tenant stringArray Deploy to this tenant (can be specified multiple times)
--tenant-tag stringArray Deploy to tenants matching this tag (can be specified multiple times). Format is 'Tag Set Name/Tag Name', such as 'Regions/South'.
--to stringArray Name or ID of the environment(s) to promote to
--update-variables Overwrite the release variable snapshot by re-importing variables from the project.
-v, --variable stringArray Set the value for a prompted variable in the format Label:Value


Global Flags:
-h, --help Show help for a command
--no-prompt Disable prompting in interactive mode
-f, --output-format string Specify the output format for a command ("json", "table", or "basic") (default "table")
-s, --space string Specify the space for operations

```

## Examples

<SamplesInstance />

```bash
octopus release promote --project MyProject --from "Development" --to "Staging"\
octopus release promote -p MyProject --from "Staging" --to "Production" --latest-successful\

```

## Learn more

- [Octopus CLI](/docs/cli)
- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key)
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
layout: src/layouts/Cli.astro
pubDate: 2023-01-01
modDate: 2026-10-02
modDate: 2026-10-16
title: octopus release snapshot-variables
description: Update the variable snapshot for a release
navOrder: 128
navOrder: 129
---
import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md';

Expand Down Expand Up @@ -32,8 +32,8 @@
<SamplesInstance />

```bash
$ octopus release snapshot-variables --project MyProject --version 1.2.3

Check failure on line 35 in src/pages/docs/cli/_generated/octopus-release-snapshot-variables.mdx

View workflow job for this annotation

GitHub Actions / lint

Dollar signs used before commands without showing output

src/pages/docs/cli/_generated/octopus-release-snapshot-variables.mdx:35:1 MD014/commands-show-output Dollar signs used before commands without showing output [Context: "$ octopus release snapshot-var..."] https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md014.md
$ octopus release snapshot-variables -p MyProject -v 1.2.3

Check failure on line 36 in src/pages/docs/cli/_generated/octopus-release-snapshot-variables.mdx

View workflow job for this annotation

GitHub Actions / lint

Dollar signs used before commands without showing output

src/pages/docs/cli/_generated/octopus-release-snapshot-variables.mdx:36:1 MD014/commands-show-output Dollar signs used before commands without showing output [Context: "$ octopus release snapshot-var..."] https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md014.md


```
Expand Down
3 changes: 2 additions & 1 deletion src/pages/docs/cli/_generated/octopus-release.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: src/layouts/Cli.astro
pubDate: 2023-01-01
modDate: 2026-10-02
modDate: 2026-10-16
title: octopus release
description: Manage releases
navOrder: 120
Expand All @@ -21,6 +21,7 @@ Available Commands:
help Help about any command
list List releases
progression Manage progression of a release
promote Promote a release
snapshot-variables Update the variable snapshot for a release

Global Flags:
Expand Down
4 changes: 2 additions & 2 deletions src/pages/docs/cli/_generated/octopus-runbook-delete.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
layout: src/layouts/Cli.astro
pubDate: 2023-01-01
modDate: 2026-10-02
modDate: 2026-10-16
title: octopus runbook delete
description: Delete a runbook
navOrder: 130
navOrder: 131
---
import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md';

Expand Down
4 changes: 2 additions & 2 deletions src/pages/docs/cli/_generated/octopus-runbook-list.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
layout: src/layouts/Cli.astro
pubDate: 2023-01-01
modDate: 2026-10-02
modDate: 2026-10-16
title: octopus runbook list
description: List runbooks
navOrder: 131
navOrder: 132
---
import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md';

Expand Down
4 changes: 2 additions & 2 deletions src/pages/docs/cli/_generated/octopus-runbook-run.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
layout: src/layouts/Cli.astro
pubDate: 2023-01-01
modDate: 2026-10-02
modDate: 2026-10-16
title: octopus runbook run
description: Run runbooks in Octopus Deploy
navOrder: 132
navOrder: 133
---
import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md';

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
layout: src/layouts/Cli.astro
pubDate: 2023-01-01
modDate: 2026-10-02
modDate: 2026-10-16
title: octopus runbook snapshot create
description: Create a runbook snapshot
navOrder: 134
navOrder: 135
---
import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md';

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
layout: src/layouts/Cli.astro
pubDate: 2023-01-01
modDate: 2026-10-02
modDate: 2026-10-16
title: octopus runbook snapshot list
description: List runbook snapshots
navOrder: 135
navOrder: 136
---
import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md';

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
layout: src/layouts/Cli.astro
pubDate: 2023-01-01
modDate: 2026-10-02
modDate: 2026-10-16
title: octopus runbook snapshot publish
description: Publish a runbook snapshot
navOrder: 136
navOrder: 137
---
import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md';

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
layout: src/layouts/Cli.astro
pubDate: 2023-01-01
modDate: 2026-10-02
modDate: 2026-10-16
title: octopus runbook snapshot snapshot-variables
description: Update the variable snapshot for a runbook snapshot
navOrder: 137
navOrder: 138
---
import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md';

Expand Down Expand Up @@ -33,8 +33,8 @@
<SamplesInstance />

```bash
$ octopus runbook snapshot snapshot-variables --project MyProject --runbook "Rebuild DB Indexes"

Check failure on line 36 in src/pages/docs/cli/_generated/octopus-runbook-snapshot-snapshot-variables.mdx

View workflow job for this annotation

GitHub Actions / lint

Dollar signs used before commands without showing output

src/pages/docs/cli/_generated/octopus-runbook-snapshot-snapshot-variables.mdx:36:1 MD014/commands-show-output Dollar signs used before commands without showing output [Context: "$ octopus runbook snapshot sna..."] https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md014.md
$ octopus runbook snapshot snapshot-variables --project MyProject --runbook "Rebuild DB Indexes" --snapshot "Snapshot 40C9ENM"

Check failure on line 37 in src/pages/docs/cli/_generated/octopus-runbook-snapshot-snapshot-variables.mdx

View workflow job for this annotation

GitHub Actions / lint

Dollar signs used before commands without showing output

src/pages/docs/cli/_generated/octopus-runbook-snapshot-snapshot-variables.mdx:37:1 MD014/commands-show-output Dollar signs used before commands without showing output [Context: "$ octopus runbook snapshot sna..."] https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md014.md


```
Expand Down
4 changes: 2 additions & 2 deletions src/pages/docs/cli/_generated/octopus-runbook-snapshot.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
layout: src/layouts/Cli.astro
pubDate: 2023-01-01
modDate: 2026-10-02
modDate: 2026-10-16
title: octopus runbook snapshot
description: Manage runbook snapshots
navOrder: 133
navOrder: 134
---
import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md';

Expand Down
4 changes: 2 additions & 2 deletions src/pages/docs/cli/_generated/octopus-runbook.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
layout: src/layouts/Cli.astro
pubDate: 2023-01-01
modDate: 2026-10-02
modDate: 2026-10-16
title: octopus runbook
description: Manage runbooks
navOrder: 129
navOrder: 130
---
import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md';

Expand Down
4 changes: 2 additions & 2 deletions src/pages/docs/cli/_generated/octopus-space-create.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
layout: src/layouts/Cli.astro
pubDate: 2023-01-01
modDate: 2026-10-02
modDate: 2026-10-16
title: octopus space create
description: Create a space
navOrder: 139
navOrder: 140
---
import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md';

Expand Down
4 changes: 2 additions & 2 deletions src/pages/docs/cli/_generated/octopus-space-delete.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
layout: src/layouts/Cli.astro
pubDate: 2023-01-01
modDate: 2026-10-02
modDate: 2026-10-16
title: octopus space delete
description: Delete a space
navOrder: 140
navOrder: 141
---
import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md';

Expand Down
4 changes: 2 additions & 2 deletions src/pages/docs/cli/_generated/octopus-space-list.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
layout: src/layouts/Cli.astro
pubDate: 2023-01-01
modDate: 2026-10-02
modDate: 2026-10-16
title: octopus space list
description: List spaces
navOrder: 141
navOrder: 142
---
import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md';

Expand Down
4 changes: 2 additions & 2 deletions src/pages/docs/cli/_generated/octopus-space-view.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
layout: src/layouts/Cli.astro
pubDate: 2023-01-01
modDate: 2026-10-02
modDate: 2026-10-16
title: octopus space view
description: View a space
navOrder: 142
navOrder: 143
---
import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md';

Expand Down
4 changes: 2 additions & 2 deletions src/pages/docs/cli/_generated/octopus-space.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
layout: src/layouts/Cli.astro
pubDate: 2023-01-01
modDate: 2026-10-02
modDate: 2026-10-16
title: octopus space
description: Manage spaces
navOrder: 138
navOrder: 139
---
import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md';

Expand Down
4 changes: 2 additions & 2 deletions src/pages/docs/cli/_generated/octopus-task-list.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
layout: src/layouts/Cli.astro
pubDate: 2023-01-01
modDate: 2026-10-14
modDate: 2026-10-16
title: octopus task list
description: List tasks
navOrder: 144
navOrder: 145
---
import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md';

Expand Down
4 changes: 2 additions & 2 deletions src/pages/docs/cli/_generated/octopus-task-wait.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
layout: src/layouts/Cli.astro
pubDate: 2023-01-01
modDate: 2026-10-14
modDate: 2026-10-16
title: octopus task wait
description: Wait for task(s) to finish
navOrder: 145
navOrder: 146
---
import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md';

Expand Down
4 changes: 2 additions & 2 deletions src/pages/docs/cli/_generated/octopus-task.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
layout: src/layouts/Cli.astro
pubDate: 2023-01-01
modDate: 2026-10-14
modDate: 2026-10-16
title: octopus task
description: Manage tasks
navOrder: 143
navOrder: 144
---
import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md';

Expand Down
4 changes: 2 additions & 2 deletions src/pages/docs/cli/_generated/octopus-tenant-clone.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
layout: src/layouts/Cli.astro
pubDate: 2023-01-01
modDate: 2026-10-14
modDate: 2026-10-16
title: octopus tenant clone
description: Clone a tenant
navOrder: 147
navOrder: 148
---
import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md';

Expand Down
4 changes: 2 additions & 2 deletions src/pages/docs/cli/_generated/octopus-tenant-connect.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
layout: src/layouts/Cli.astro
pubDate: 2023-01-01
modDate: 2026-10-14
modDate: 2026-10-16
title: octopus tenant connect
description: Connect a tenant to a project
navOrder: 148
navOrder: 149
---
import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md';

Expand Down
4 changes: 2 additions & 2 deletions src/pages/docs/cli/_generated/octopus-tenant-create.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
layout: src/layouts/Cli.astro
pubDate: 2023-01-01
modDate: 2026-10-14
modDate: 2026-10-16
title: octopus tenant create
description: Create a tenant
navOrder: 149
navOrder: 150
---
import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md';

Expand Down
4 changes: 2 additions & 2 deletions src/pages/docs/cli/_generated/octopus-tenant-delete.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
layout: src/layouts/Cli.astro
pubDate: 2023-01-01
modDate: 2026-10-14
modDate: 2026-10-16
title: octopus tenant delete
description: Delete a tenant
navOrder: 150
navOrder: 151
---
import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md';

Expand Down
4 changes: 2 additions & 2 deletions src/pages/docs/cli/_generated/octopus-tenant-disable.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
layout: src/layouts/Cli.astro
pubDate: 2023-01-01
modDate: 2026-10-14
modDate: 2026-10-16
title: octopus tenant disable
description: Disable a tenant
navOrder: 151
navOrder: 152
---
import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md';

Expand Down
4 changes: 2 additions & 2 deletions src/pages/docs/cli/_generated/octopus-tenant-disconnect.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
layout: src/layouts/Cli.astro
pubDate: 2023-01-01
modDate: 2026-10-14
modDate: 2026-10-16
title: octopus tenant disconnect
description: Disconnect a tenant from a project
navOrder: 152
navOrder: 153
---
import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md';

Expand Down
Loading
Loading