Version 1.2.0

Added

• matches_reference_hash_file has been added to the top-level API. This function
  will try to infer the file type from the path of the file under comparison and
  then use the relevant comparison functionality for HDF-5, netCDF4 or GeoTIFF
  files.

Changed

• Release notes published in GitHub should now also contain a list of commit
  messages since the last release. These will omit commits from pre-commit-ci.

Commits

DAS-2397: Add single entry point function for all file types. (#24)
TRT-315: Append commit history to release notes. (#20)
TRT-701: Update documentation for skipped_metadata_attributes (#18)
TRT-701: Update documentation with GeoTIFF functionality. (#14)

Version 1.1.0

Added

• The ability to parse and generate hashes for a GeoTIFF file using
  create_geotiff_hash_file.
• The ability to compare a GeoTIFF file to a reference hash file via
  geotiff_matches_reference_hash_file.
• Exposing the ability to retrieve JSON objects, rather than only produce JSON
  output files via get_hash_from_geotiff_file, get_hashes_from_h5_file and
  get_hashes_from_nc4_file.

Version 1.0.2

Changed

• No functional changes. Internal xarray function changed to suppress future warning.

Version 1.0.1

Changed

• Keys in JSON output files are now sorted alphabetically. This does not affect
  comparisons against JSON files that are not alphabetically sorted, as the
  comparison first checks the sets of keys in both files, and then ensures that
  the value assigned to the same key in both files are the same. Neither of
  these operations are dependent on the key ordering in the file itself. This
  does, however, prepare the way for future functionality to display the
  difference between two files with different hash values.

Version 1.0.0

Added

• Initial repository setup, including README and LICENSE.
• Migration of hashing code from Harmony Regression Tests repository.
• Addition of unit tests.
• Packaging using hatch.
• pre-commit CI/CD checks, including mypy and ruff.
• CI/CD workflows as GitHub actions.