Execution Results API Enhancements

The Execution Results API has been updated to make it easier to tell whether a deployment was successful when taking automatic plan retries into account. A new top-level object was added to the response that looks similar to the following:

{
  "event_status": {
    "succeeded": true,
    "succeeded_first_attempt": false,
    "succeeded_with_retries": true,
    "succeeded_by_plan": {
      "6DTUdMlA6oBt1vnA-4fAZA-p": true
    }
  },
...
}

This additional information will enable you to easily determine whether the tests that were executed as a result of a deployment event completed successfully, even if some executions failed but later succeeded on retry.

The new fields inside event_status will only be populated once all tests have completed. The succeeded_with_retries field will only be present if any executions were retried. The easiest way to programmatically determine whether a deployment was successful is now to inspect the value of the event_status.succeeded field.

Additional information has been added about plan executions as well:

...
      "plan_execution": {
        "id": "lW3hFfTccLRfc4DYC74Rtg-pr",
        "status": "true",
        "is_retry": true,
        "retry_of_id": "NH0e4YFMw3eW1yFLAG0u6Q-pr"
      },
...

This information allows you to know which executions are retries.