Skip to content

Commit b42e9e7

Browse files
authored
Make ADO v6 API usage clearer (#3239)
1 parent a813ecc commit b42e9e7

2 files changed

Lines changed: 17 additions & 7 deletions

File tree

src/pages/docs/packaging-applications/build-servers/tfs-azure-devops/using-octopus-extension/index.mdx

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: src/layouts/Default.astro
33
pubDate: 2023-01-01
4-
modDate: 2023-06-28
4+
modDate: 2026-07-13
55
title: Using the Octopus extension
66
description: Octopus Deploy and Azure DevOps can work together to make automated, continuous delivery easy.
77
navOrder: 1
@@ -11,11 +11,15 @@ import TfsNotice from 'src/shared-content/azure-ado/tfs-notice.include.md';
1111
import BuildInformationInReleaseNotesWithArc from 'src/shared-content/build-information/using-build-information-in-release-notes-with-arc.include.md'
1212

1313
:::div{.warning}
14-
Version 6 of the Octopus extension for Azure DevOps no longer requires the Octopus CLI to be installed.
14+
Version 6 of the Octopus extension for Azure DevOps no longer requires the Octopus CLI to be installed. Instead, v6+ steps call the Executions API directly, which requires Octopus Server 2022.3 or later. Learn more about this change in our [Azure DevOps extension v6 blog post](https://octopus.com/blog/azure-devops-octopus-v6).
1515

1616
The use of the **Additional Arguments** field has been deprecated and is only left in place to ease migration from earlier versions.
1717
:::
1818

19+
:::div{.hint}
20+
You can still write a YAML pipeline that calls the Octopus CLI yourself. See [Installing the Octopus CLI as a capability](/docs/packaging-applications/build-servers/tfs-azure-devops/using-octopus-extension/install-octopus-cli-capability) for more information.
21+
:::
22+
1923
We've created a [public extension](https://marketplace.visualstudio.com/items/octopusdeploy.octopus-deploy-build-release-tasks) you can install into your Azure DevOps instance. This extension makes the following tasks available to your Build and Release processes:
2024

2125
- The Octopus Tools installer task.
@@ -80,7 +84,7 @@ Version 6+ of each of the steps, no longer requires View permissions.
8084
- DeploymentView (for the dashboard widget)
8185
- TaskView (for the dashboard widget)
8286
- BuildInformationPush (for pushing build information to Octopus)
83-
- BuildInformationAdminister (required if `Overwrite Mode` is set to `Overwrite Existing`)
87+
- BuildInformationAdminister (required if `Overwrite Mode` is set to `Overwrite Existing`)
8488

8589
## Demands and the Octopus tools installer task
8690

@@ -319,9 +323,9 @@ Hover over the widget and click the wrench icon to configure the widget.
319323
Select an Octopus Deploy connection (see the [Add a Connection](#add-a-connection-to-octopus-deploy) section for details), a Project, and an Environment.
320324

321325
:::figure
322-
![](/docs/img/packaging-applications/build-servers/tfs-azure-devops/using-octopus-extension/images/widget-setup-preview.jpg)
326+
![Octopus Deploy Status widget configuration showing connection, project, and environment fields](/docs/img/packaging-applications/build-servers/tfs-azure-devops/using-octopus-extension/images/widget-setup-preview.jpg)
323327
:::
324328

325329
The widget should refresh to show the current status of the selected project in the selected environment.
326330

327-
![](/docs/img/packaging-applications/build-servers/tfs-azure-devops/using-octopus-extension/images/multiple-widget-preview.jpg)
331+
![Several Octopus Deploy Status widgets on an Azure DevOps dashboard, each showing the deployment status for a different project and environment](/docs/img/packaging-applications/build-servers/tfs-azure-devops/using-octopus-extension/images/multiple-widget-preview.jpg)

src/pages/docs/packaging-applications/build-servers/tfs-azure-devops/using-octopus-extension/install-octopus-cli-capability.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: src/layouts/Default.astro
33
pubDate: 2023-01-01
4-
modDate: 2023-01-01
4+
modDate: 2026-07-13
55
title: Installing the Octopus CLI as a capability
66
description: This guide covers how to add the Octopus CLI as a capability to your Azure DevOps custom build agents.
77
---
@@ -84,6 +84,12 @@ Version 6+ of each of the steps no longer require installing the CLI
8484

8585
Version 6 of the Octo CLI installer will only install the new [Octopus CLI](https://github.com/OctopusDeploy/cli).
8686

87+
:::div{.hint}
88+
**Using the CLI directly in a YAML pipeline**
89+
90+
The other v6+ tasks in this extension (for example, **Create Octopus Release** or **Deploy Octopus Release**) call the [Executions API](https://octopus.com/blog/azure-devops-octopus-v6) directly and no longer use the Octopus CLI under the hood. If you'd rather call the CLI yourself: install it with the **Octopus CLI Installer** task, then call `octopus` directly from a script step in your pipeline.
91+
:::
92+
8793
## Using the Octopus CLI with Self-Hosted Agents
8894

8995
Self-hosted agents provide the ability to install tools that are required for builds and deployments. They can also improve build performance since their associated configuration is persisted between runs.
@@ -111,7 +117,7 @@ These task demands were introduced and mandated in version 5 to ensure the avail
111117

112118
If this user-defined capability described above is not defined for self-hosted agents then jobs will fail with the following error:
113119

114-
```
120+
```text
115121
No agent found in pool [POOL-NAME] which satisfies demands: octo
116122
```
117123

0 commit comments

Comments
 (0)