Skip to content

Conversation

@caitlynstocker
Copy link
Contributor

@caitlynstocker caitlynstocker commented Oct 27, 2025

What's this? 🌵

This PR add task ids to the responses for both of our ephemeral environment deprovisioning API endpoints to match backend changes here.

This is a breaking change, however both endpoints are marked as 'experimental` while the ephemeral environments feature is still in development, meaning that they should not be in use by any Octopus customers (or that any customers using them know that they are doing so at their own risk 👻).

This change will allow us to quickly return service task ids in our GitHub action to deprovision environments. It should also give our deprovisioning response types a more flexible shape for adding other properties after they are officially in use.

🐞 This PR also fixes a bug where the response type to deprovision for a single project was being used for both deprovisioning endpoints. With this change, the endpoint to deprovision across multiple projects now has its own response type representing an array of deprovisioning runs.

Testing 🧪

This has been tested locally using the example code under examples/src/environments/

How to review? 🔍

☑️ Code quality?
❔ Any scary consequences of the breaking change?

Fixes[sc-124036]

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR updates the response types for ephemeral environment deprovisioning API endpoints to include task IDs alongside runbook run IDs. The changes support the ability to quickly return service task IDs in GitHub actions while making the response structure more extensible for future properties.

  • Introduces DeprovisioningRunbookRun type containing both RunbookRunId and TaskId
  • Updates DeprovisionEphemeralEnvironmentProjectResponse to use the new type structure
  • Adds new DeprovisionEphemeralEnvironmentResponse type for the general deprovisioning endpoint

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@caitlynstocker caitlynstocker marked this pull request as ready for review October 28, 2025 02:28
Copy link
Contributor

@stevencl840 stevencl840 left a comment

Choose a reason for hiding this comment

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

Looks good

@caitlynstocker caitlynstocker changed the title Add TaskIds to ephemeral environment deprovisioning response types Add task ids to ephemeral env deprovisioning endpoint response types Oct 28, 2025
@caitlynstocker caitlynstocker changed the title Add task ids to ephemeral env deprovisioning endpoint response types fix: Update ephemeral env deprovisioning response types Oct 28, 2025
@caitlynstocker caitlynstocker merged commit b6f508f into main Oct 29, 2025
6 checks passed
@caitlynstocker caitlynstocker deleted the cat/124036/ee-deprov-return-task-ids-list branch October 29, 2025 00:39
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.

2 participants