Deprecation Notes

To iterate on features, improve consistency, and develop for scalability, the following features will be removed in future releases.

Release notes will be published when the changes come into effect, with reference to the deprecation notices.

Deprecations announced for Alpha release

4 November 2022

Planned release for the four announcements below: Prior to the end of Q4, December 2022.

Warning

These will be breaking changes.

TaskStatusEvent and CloseRunEvent

TaskStatusEvent and CloseRunEvent in the Event Ingestion API will be deprecated and a single RunStatusEvent will be used. The new event optionally accepts a task_key field to differentiate the status for a run task and the run itself. [PD-618]

TestResultsEvent

The TestResultsEvent in the Event Ingestion API will be deprecated and replaced with a TestOutcomesEvent. [PD-720]

AddRunStateEvent and CustomEvent

AddRunStateEvent and CustomEvent in the Event Ingestion API will be removed. At this time, no alternatives are in development. [PD-754]

name field

In the Event Ingestion API, the event key name field has reached end of support and will be replaced by a key field. For example, the property pipeline_name will become pipeline_key. Additionally, run_tag will be renamed to run_key. [PD-613]

Terminology

Deprecation: the feature is no longer recommended for use and will be removed in a future release.

End of support: the feature is no longer supported in development, testing, or fixes and will be deprecated in a future release.

Breaking change: any change to the user interface or application that requires clients to make corresponding updates to their existing settings or code.