Skip to content

Conversation

@octopus-hideaki
Copy link
Contributor

@octopus-hideaki octopus-hideaki commented Apr 2, 2025

Background

OctopusDeployRelease V5 allowed for the progress of the deployment to be shown. Since OctopusDeployRelease V6, the waiting for the deployment task to finish has been moved to the OctopusAwaitTask. However, this task is currently missing an option to show the progress of the deployment.

Results

Adds a new optional ShowProgress flag to OctopusAwaitTask V6.
Fixes #342
[sc-104339]

Before

image

After

image

Testing

This was tested on Azure DevOps Server 2022 and Azure DevOps Server 2019.

Note that V6 Tasks are only supported on Azure DevOps Server 2019+

Functionality Tested:

  • Waiting on Deployments
  • Waiting on Runbooks

Scenarios Tested:

  • ShowProgress flag on/off
  • Failing tasks
  • Tasks with warnings
  • Successful tasks
  • Cancelling tasks

Copy link

@mik-ky mik-ky left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes make sense to me - haven't tested it out myself for obvious reasons, though 😄


await waiter.waitForServerTasksToComplete(taskIds, inputParameters.pollingInterval * 1000, inputParameters.timeout * 1000, (t) => {
const taskResult = lookup.get(t.Id);
if (!taskResult) return;
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

timeoutSeconds = +timeoutField;
}

const showProgress = task.getBoolean("ShowProgress") ?? false;
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess it's good to be explicit?

@octopus-hideaki octopus-hideaki merged commit baed510 into main Apr 13, 2025
9 checks passed
@octopus-hideaki octopus-hideaki deleted the fnm/await-with-progress-logging branch April 13, 2025 21:37
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

Successfully merging this pull request may close these issues.

Add "Show Deployment Progress" option to "Await Octopus Task Completion" task

2 participants