driftpipev0.9.4docs for Sign in

Changelog

NAME

changelog - fourteen releases, two of them breaking

Also available as an Atom feed and as structured data at /api/releases.json.

CONVENTIONS

  • Dates are release dates in UTC. There are no unreleased entries on this page: a change appears here when a tag exists.
  • Breaking marks a change that can make a previously passing pipeline fail, including lock format changes.
  • Patch releases exist only where a fix mattered enough to cut one. There is no monthly cadence and there will not be one.
  • Version 0.x means the lock format may still change. Each change reads the previous format and says what to do.

RELEASES

0.9.4 2026-09-24

  • Fixed - --timeout was armed around the whole run but not checked inside the decode loop, so a 40 GB file ignored it until the first record boundary after expiry. It is now checked every 4096 records.
  • Fixed - explain --path on a path ending in [] printed the parent instead of the element shape.
  • Changed - The header line reports elapsed time in milliseconds below one second, instead of printing 0.18s.

0.9.3 2026-08-20

  • Fixed - Windows path handling: a drive-letter path passed to --schema was split on the colon and treated as a URL-like prefix.
  • Fixed - Wildcard ignore patterns matched one segment too many, so meta.* also hid meta.a.b.
  • Fixed - Carriage returns at the end of newline-delimited input produced an input error on the last record only.

0.9.0 2026-06-09

  • Added - OCI image, published to reg.driftpipe.sh and built from the release tag.
  • Added - --print-config, which resolves every setting and names the source it came from.
  • Changed - Lock format 3: unions are written sorted with |, and the sample and max_depth used at snapshot time are recorded. Format 2 locks are still read.
  • Changed - Breaking: --sample now defaults to 5000 instead of reading the whole stream. Pipelines that relied on the old behaviour need --sample 0.

0.8.1 2026-02-26

  • Fixed - Gzip detection consumed two bytes from standard input and did not put them back, so a gzipped stream on a pipe failed while the same file on disk worked.

0.8.0 2025-12-04

  • Added - --max-depth and the depth_exceeded class. Previously a pathological document could grow the path set without bound.
  • Added - Lock format 2, carrying the note and the record count. Format 1 locks are upgraded in place by snapshot --force.
  • Changed - A path that is both widened and made nullable is now reported once, as nullability, instead of twice.

0.7.0 2025-08-11

  • Added - The explain command, with a text tree and a JSON form.
  • Added - --note on snapshot.
  • Fixed - The summary line counted an ignored path as a difference when the pattern contained [].

0.6.1 2025-04-29

  • Fixed - Report order depended on map iteration, so two runs over the same input could print the same differences in a different order. Paths are now sorted bytewise before comparison.

0.6.0 2025-04-03

  • Added - --format github, emitting annotation lines that point at the entry in the lock file.
  • Added - --fail-on with any and breaking, replacing the older --strict boolean.
  • Changed - --strict is accepted as a hidden alias and prints a deprecation line on standard error.

0.5.0 2025-01-15

  • Changed - Breaking: the type model was rewritten. int and float are separate types with one widening edge between them, and nullability became its own class rather than a flag on the path. Locks written by 0.4.x cannot be compared and must be re-snapshotted.
  • Removed - The number type, which collapsed integers and reals and hid the most common real drift we saw in practice.

0.4.1 2024-10-22

  • Fixed - --ignore with an array segment was matched against the pre-collapse path and never fired.

0.4.0 2024-10-07

  • Added - Config file .driftpipe.yml, the rules map, and the documented precedence between flag, environment and file.
  • Added - DRIFTPIPE_CONFIG.

0.3.0 2024-07-18

  • Added - --format json.
  • Added - Gzip input, detected from the first two bytes.
  • Changed - Colour is disabled automatically when standard output is not a terminal.

0.2.0 2024-05-02

  • Added - --ignore, repeatable, with the path pattern syntax that is still in use.
  • Changed - Drift exits 3; usage errors keep 1 and input errors move to 2. Before this release everything non-zero was 1, which made the tool unusable in a pipeline that wanted to tell the two apart.

0.1.0 2024-03-12

  • Added - First release. check and snapshot, newline-delimited JSON input, text output, lock format 1.

LOCK FORMAT HISTORY

FormatIntroducedRead by 0.9.4Note
30.9.0yes, currentsorted unions, snapshot settings recorded
20.8.0yesupgraded in place by snapshot --force
10.1.0no, exit 4predates the int and float split; re-snapshot

A lock written by a future format also exits 4 rather than being read optimistically. The message names both versions, so the fix is obvious from the CI log alone.