Skip to content

Release notes

What changes for users in each version of Wayloop, in plain language. The technical history of every change is in the changelog. On the documentation site, the first section lists the changes not yet released.

Wayloop Unreleased

Action required

  • The wayloop steps command now prints the step identifiers in snake_case, as every value of the JSON contracts: counter_review and pull_request replace counter-review and pull-request. Scripts that read these two values need the new spelling. (#228)

New

  • The new command wayloop validate --input <file> checks briefs against their schema and reports every error in one pass: the pointer of the faulty value and the document it belongs to, the reason, the accepted values or the corrected key, and the file and line where the value is stored. A brief written against an unknown schema version is refused with the versions the engine knows. Checks of the other artifact types are listed as not done in the result until they are built. The command always prints a JSON result, also when its command line is wrong or its input file cannot be read. (#256)
  • The JSON schema of the envelope that wraps every command result is published under https://salvo8519.github.io/wayloop/schemas/envelope/result/, with the history of the contract in index.json and the SHA-256 of every version, so that an integration can pin the exact contract it was built against. (#294)
  • The result envelope that every command returns now has a JSON Schema generated from the engine's own types, and the engine can only build results that match it: a success carries data, a refused input or an engine failure carries error, never both, and an engine failure is told apart from a refusal by the reason internal of its errors. (#295)

Fixed

  • The wayloop command no longer stops with an internal error when its output cannot be written, for example when the reading end of a pipe is closed: it reports the cause and exits with code 3, an environment error. (#238)