CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[unreleased]

Changed

• CI now builds a GraalVM native binary on every PR and runs a smoke test against each subcommand (generate, compare, compare-files), so native-image regressions are caught before release rather than at tag time. See #98.
• CI build and native-binary smoke jobs are now skipped on PRs that touch only Markdown files, while Gitleaks and Snyk continue to run. See #98.
• CI now cancels in-flight runs on the same branch / PR when a new commit is pushed, so only the latest commit's checks consume runner minutes (pushes to main are exempt and always run to completion). See #98.

Removed

• Removed the orb/ directory (CircleCI orb test fixtures: SQL migrations and pre-generated Avro schemas). We ended up not using these fixtures — they were never wired into any code, build script, CI workflow, or test in this repository.

[1.4.1] - 2026-05-14

Fixed

• Native image startup crash (ExceptionInInitializerError) introduced by the Debezium 3.2+ OpenLineage integration: io/debezium/openlineage/build.version is now registered as a native image resource so that Properties.load() can read it at runtime. Thank you to @adamkaplan0 for the fix!

[1.4.0] - 2026-05-14

Note

In an excess of caution, we are bumping the minor version of Skemium to match the bumping in minor version of Debezium. As Debezium is a core dependency here, we prefer to signal this change more clearly than with a patch version bump. BUT, in our testing though, not breaking change has surfaced in Skemium.

Changed

• Bumped Debezium from 3.2.7.Final to 3.4.3.Final.
• Bumped grouped Java dependencies: JUnit BOM 5.14.3 → 5.14.4, lz4-java 1.10.4 → 1.11.0, slf4j-api 2.0.17 → 2.0.18, commons-codec 1.21.0 → 1.22.0, and Jackson modules (jackson-core, jackson-databind, jackson-datatype-jsr310, jackson-dataformat-avro) 2.21.2 → 2.21.3.
• Bumped GitHub Actions softprops/action-gh-release from 2 to 3 in the release workflows.
• Updated CODEOWNERS (PRODSEC-10215).

Fixed

• Upgraded org.postgresql:postgresql to 42.7.11 to address security vulnerabilities.

[1.3.0] - 2026-04-02

Added

• Taskfile task compile to compile the project without running tests.
• Taskfile tasks deps.show-patch-updates and deps.show-minor-updates to inspect available dependency updates.

Changed

• Bumped Debezium from 3.0.8.Final to 3.2.7.Final, along with other dependency updates.

Fixed

• Compatibility with Debezium 3.2.x: the PostgreSQL connector no longer populates the catalog in TableId, so the database name is now explicitly prepended to form database.schema.table identifiers.
• CatalogSchemaAndTableTopicNamingStrategy now handles a null catalog gracefully instead of producing null.schema.table topic names.
• Corrected maven-native-plugin version (0.11.4 is the actual latest, not 0.11.5).

[1.2.4] - 2026-03-03

Fixed

• Corrected maven-native-plugin version to 0.11.4 (the actual latest release).

[1.2.3] - 2026-03-03

Changed

• Bumped all dependencies to their latest compatible versions.
• Configured Dependabot to group dependency PRs into a single PR per ecosystem.
• Added AGENTS.md for AI-assisted development context.

Fixed

• Upgraded jackson-core to 2.21.1 to address a security vulnerability.

[1.2.2] - 2026-01-20

Changed

• Bumped Jackson to 2.21.0, PostgreSQL driver to 42.7.9, Logback to 1.5.25, and jackson-annotations to 2.21.
• Dependabot configured to skip major version bumps and avoid running Gitleaks/Snyk CI on Dependabot PRs.

[1.2.1] - 2026-01-20

Fixed

• CI release workflow updated to use latest supported macos images and to override (not append) release body across parallel jobs.

Added

• Dependabot configuration for automated Maven and GitHub Actions dependency updates.

[1.2.0] - 2026-01-19

Added

• --include-schema option for the compare-files command, allowing external Avro schema files to be included for type resolution during comparison. Thank you to @MantasSnyk for the contribution!

Changed

• Updated all Java dependencies and CI workflow actions to latest versions.

Fixed

• Addressed lz4-java security vulnerabilities (SNYK-JAVA-ORGLZ4-14151788 and SNYK-JAVA-ORGLZ4-14219384).

[1.1.0] - 2025-11-04

Added

• New compare-files command to compare two individual .avsc files for compatibility, with support for external type resolution. Thank you to @MantasSnyk for the contribution!
• --ci-mode flag for comparison commands: fails on any schema change (including compatible ones), table additions, or removals.
• Schema equality checking with JSON normalization (sorts object keys and record fields by name before comparing).
• Testing schemas and migrations for the CircleCI orb. Thank you to @ramonr for the contribution!

Changed

• Refactored ComparisonCommand into BaseComparisonCommand to share logic between compare and compare-files.
• Updated release process documentation in README.md.

Fixed

• Restored Snyk CI integration after GitHub SARIF format changes.
• Upgraded logback-classic to 1.5.19 to fix SNYK-JAVA-CHQOSLOGBACK-13169722.

[1.0.3] - 2025-07-28

Fixed

• Upgraded commons-compress to address vulnerability SNYK-JAVA-ORGAPACHECOMMONS-10734078.

[1.0.2] - 2025-06-16

Added

• Taskfile.yml for convenient project task management (task package, task clean, etc.).

Changed

• Tweaked logging levels, adding a conclusion message at INFO level for each command.

Fixed

• Upgraded postgresql and kafka dependencies to address security vulnerabilities (SNYK-JAVA-ORGPOSTGRESQL-10343494, SNYK-JAVA-ORGAPACHEKAFKA-10336719). Thank you to @snyk-io for the fix!

[1.0.1-rc5] - 2025-06-11

Added

• The --table filter option now supports the DB_SCHEMA.DB_TABLE format (e.g., public.artist) in addition to just table names.

Fixed

• Typo in README.md. Thank you to @SorooshDeveloper for the fix!

[1.0.0-rc4] - 2025-06-06

Fixed

• Provided GraalVM reachability metadata hints for dynamically-loaded classes and resources, fixing native binary crashes at runtime.

[1.0.0-rc3] - 2025-06-06

Fixed

• Compiled GraalVM native binaries with -march=compatibility to avoid CPU feature mismatches on different hardware (previously used -march=native which hyper-optimised for the build machine).

[1.0.0-rc2] - 2025-06-04

Added

• linux-aarch64 native binary to release artifacts.

[1.0.0-rc1] - 2025-06-04

Added

• compare command: compares two directories of generated Avro schemas for backward/forward/full compatibility.
• --output option for the compare command to save results as a JSON file.
• -v|--verbose flag (repeatable) to control logging verbosity (default ERROR, up to TRACE).
• -x|--exclude-column option for the generate command to exclude specific table columns.
• Generation of key, value, and envelope Avro schemas (previously only value schemas were generated).
• Published Avro schema definitions for Skemium's own output formats (schemas/*.avsc).
• CI check to detect uncommitted schema file changes after tests.

Changed

• Refactored AvroSchemaFile to TableAvroSchemas for clearer naming.
• Refactored CheckCompatibilityResult to CompatibilityResult.
• checkCompatibility now returns a detailed Record with per-schema-type incompatibility lists.

[0.0.1-dev] - 2025-04-28

Added

• Initial release of Skemium.
• generate command: connects to a PostgreSQL database, extracts table schemas, converts them to Avro, and saves to a directory.
• PostgreSQL TableSchemaFetcher implementation using Debezium's schema extraction.
• CatalogSchemaAndTableTopicNamingStrategy for <catalog>.<schema>.<table> topic/identifier naming.
• Metadata file (.skemium.meta.json) generation with VCS information, checksums, and CLI arguments.
• SHA256 checksum validation on schema load.
• CI via GitHub Actions (Gitleaks, Snyk, build and test).
• Release workflows for uber-JAR and GraalVM native binaries (linux-x86_64, macos-x86_64, macos-aarch64).
• Test infrastructure using Testcontainers with the Chinook sample database.