@qawolf/ci-sdk 2.1.0 → 2.5.0

package/README.md

@@ -454,8 +454,10 @@ const sdk = makeQaWolfSdk(
 This package follows the [SemVer](https://semver.org/) versioning scheme. Additional notes:
 
 - We recommend depending on the `^` range operator for this package, as it will not introduce breaking changes and guarantee an up-to-date API usage version.
+
 <!-- There is a limitation in NPM preventing us from using relative links and hosting other MD files when the repository hosting code is not
   public, hence we inline the changelog in the README. See https://github.com/npm/feedback/discussions/666 -->
+
 - We will provide a changelog for each release, which will be available in the Changelog section below.
 - This package major version will be bumped when an API breaking change is introduced. This won't
   happen too often, and we will reach out to you and give advance notice when it does.
@@ -467,6 +469,19 @@ This package follows the [SemVer](https://semver.org/) versioning scheme. Additi
 
 # Changelog
 
+## v2.5.0
+
+- `attemptNotifyDeploy`: QA Wolf no longer sends `skipped_triggers` on the `deploy_success` response, so against a current backend `skippedTriggers` is absent and `failReason: "trigger-skipped"` does not occur. A trigger that matched the deployment but could not run now reaches you as `outcome: "skipped"` rather than `outcome: "failed"`, so a deploy step that used to fail in that case passes instead. This most often happens when the environment has no enabled tests, where there is nothing to run and nothing to retry. Both `skippedTriggers` and the `trigger-skipped` reason stay in the types and are still parsed, so no caller has to change and a self-hosted backend that predates the change keeps working. Note that this response no longer distinguishes a matched-but-unrunnable trigger from a deployment that matched nothing, and its log line reads as though nothing matched.
+
+## v2.4.0
+
+- `attemptNotifyDeploy` and `notifyTerminatedEphemeralEnvironment`: the response may now carry a `warning` about the request itself rather than its outcome, and the SDK logs it through `log.warn`. Today it is sent when an organization or user API key omits `workspaceId`, in which case QA Wolf uses your organization's first-created workspace and the warning names it. The warning never changes the outcome, and it is absent against a backend that predates it. `attemptNotifyDeploy` also exposes it as `warning` on `DeployStatus`.
+
+## v2.3.0
+
+- `attemptNotifyDeploy`: a failed suite result now carries `failureCode` and `failureMessage` alongside the existing `failureReason`. `failureCode` is a stable code to branch on, such as `billing-prevented`, `environment-terminated`, `environment-not-ready`, `test-configuration-error`, or `internal-error`; treat it as an open set, since new codes are added over time. Note that `environment-terminated` is permanent while `environment-not-ready` clears on its own, so retrying is worthwhile only for the second. `failureMessage` is human-readable copy for logs, and the SDK's own failure log line now prints it instead of the internal reason.
+- `attemptNotifyDeploy`: `failureReason` is deprecated. It still ships unchanged and is safe to keep reading, but it carries an internal diagnostic whose values change without notice. Branch on `failureCode` and display `failureMessage` instead. Both are `undefined` when the SDK talks to a backend that predates them.
+
 ## v2.1.0
 
 - `attemptNotifyDeploy`: the `deploy_success` response is now validated at runtime instead of being trusted. A response with a non-JSON body, or a body that does not match the expected shape, returns `outcome: "aborted"` with the new `abortReason: "invalid-response-body"`. This is distinct from `"network-error"`, which now covers only transport and body-stream failures rather than also masking unparseable responses. A result the SDK does not recognize (for example a new result kind sent by a newer backend) returns `outcome: "failed"` with the new `failReason: "unknown-result"` instead of being reported as a success. Recognized results are unchanged, and older backends that omit newer fields remain fully supported.