Skip to content

v1.4.0
Compare
Choose a tag to compare
@tzaeschke tzaeschke released this 09 Sep 15:05
v1.4.0
4b19a34
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.

What's new

This release is a pure project structure release, no PH-tree features were added or fixed.
This is a breaking release:

  • if you are using bazel, bazel dependency has now to be declared with 
     deps = [
     "@phtree//:phtree",
 ],
  • if you included the following files directly: converter.h, distance.h or filter.h. These have been moved from the common directory to the parent directory because they are part of the API.

This release focuses on project structure and build systems:

  • Structure: The library has been moved into a subdirectory called include. Tests and benchmarks have been moved to separate folders.
  • Bazel: Cleaned up bazel import (now requires deps = ["@phtree//:phtree"])
  • Cmake: Added support for FetchContent, find_package() (after cmake install) and inclusion via add_subfolder()
  • Doc: Added section to README.md on how to include the phtree when using bazel or cmake
  • Code quality: Added code coverage and linting, and additional projects to verify build ability.
  • A ton of script cleanup, build success badges

Personal note: I am aware that these are breaking changes in a minor release. I hope this is acceptable because the code should be easy to adapt (no API changes) and pretty much optional anyway (there are no functional changes to the PH-tree itself). Having only project and build system changes didn't seem to justify a major release. I'll try to adhere to semantic versioning from now on.

Changelog

Added

  • Added build features: #53
    • linting for C++ and bazel files.
    • Added CI status badges.
    • Added test coverage
  • Added support for cmake FetchContent. See README for details. #75
  • Added support for cmake find_packet() and direct import via add_sub_directory(). See README for details. #83

Changed

  • Cleaned up build scripts. #53
  • Fixed code coverage + migrate to linux. #80
  • BREAKING CHANGE The project has been restructured to have a more "standard" directory structure. This affects how bazel dependencies work (use deps = ["@phtree//:phtree",]) and enables cmake FetchContent_. See README for details. #75

See CHANGELOG

Assets 2
Loading