Skip to content

CHANGELOG.md

Latest commit

 

History

History
212 lines (125 loc) · 6.66 KB

CHANGELOG.md

File metadata and controls

212 lines (125 loc) · 6.66 KB

Changelog

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

The format is based on Keep a Changelog.

[2.1.0]

Changed

  • 284 - Update pyyaml to 6.0.2 in poetry.lock by @gsnider2195
  • 286 - Update GitHub Actions runner version by @mjbear
  • 289 - Remove upper limit on Packaging by @jdrew82

New Contributors

[2.0.1]

Changed

  • #276 - Removed upper version bound for structlog dependency

Fixed

  • #281 - Properly deprecated DiffSync class name
  • #273 - Properly capitalized DiffSync in documentation
  • #273 - Removed more mentions of DiffSync in favor of Adapter
  • #274 - Fixed doc section title for getting started
  • #269 - Fixed wording for a couple of docstrings
  • #265 - Fixed readthedocs build

[2.0.0]

Changed

  • BREAKING CHANGE #236/240 - Upgrade to Pydantic v2.

[1.10.0] - 2023-11-16

Fixed

  • #249 - Fixes natural deletion order flag
  • #247 - Fixes underspecified typing_extensions dependency

Changed

  • #247 - Deprecates Python 3.7

[1.9.0] - 2023-10-16

Added

  • #220 - Implement DiffSyncModelFlags.NATURAL_DELETION_ORDER.

Changed

  • #219 - Type hinting overhaul

[1.8.0] - 2023-04-18

Added

  • #182 - Added get_or_add_model_instance() and update_or_add_model_instance() APIs.
  • #189 - Added note in README.md about running invoke tests.
  • #190 - Added note in README.md about running invoke build.

Changed

  • #77/#188 - sync_from() and sync_to() now return the Diff that was applied.
  • #211 - Loosened packaging and structlog library dependency constraints for broader compatibility.

[1.7.0] - 2022-11-03

Changed

  • #176 - Remove pytest-redislite in favor of pytest-redis.
  • #174 - Update Dockerfile to install build-essential

Added

  • #174 - Add methods to load data from dictionary and enable tree traversal
  • #174 - Add a get_or_none method to the DiffSync class
  • #168 - Add 'skip' counter to diff.summary()
  • #169/#170 - Add documentation about model processing order
  • #121/#140 - Add and configure renovate
  • #140 - Add renovate configuration validation to the CI

Fixed

  • #149 - Limit redundant CI concurrency

[1.6.0] - 2022-07-09

Changed

  • #120 - Dropped support for Python 3.6, new minimum is Python 3.7

[1.5.1] - 2022-06-30

Added

  • #111 - Added example 6, regarding IP prefixes.

Changed

  • #107 - Updated example 5 to use the Redis backend store.

Fixed

  • #115 - Fixed ReadTheDocs rendering pipeline
  • #118 - Fixed a regression in DiffSync.get(modelname, identifiers) introduced in 1.5.0

[1.5.0] - 2022-06-07

Added

  • #106 - Add a new, optional, backend store based in Redis

[1.4.3] - 2022-03-03

Fixed

  • #101 - Revert changed introduced in #90 that affected DiffElement.action

NOTE: this change is a breaking change against DiffSync 1.4.0 through 1.4.2, but was necessary to restore backward compatibility with DiffSync 1.3.x and earlier. Apologies for any inconvenience this causes.

Changed

  • #103 - Update development dependencies

[1.4.2] - 2022-02-28

WARNING - #90 inadvertently introduced a breaking API change in DiffSync 1.4.0 through 1.4.2 (#101); this change was reverted in #102 for DiffSync 1.4.3 and later. We recommend not using this release, and moving to 1.4.3 instead.

Fixed

  • #100 - Added explicit dependency on packaging.

[1.4.1] - 2022-01-26

WARNING - #90 inadvertently introduced a breaking API change in DiffSync 1.4.0 through 1.4.2 (#101); this change was reverted in #102 for DiffSync 1.4.3 and later. We recommend not using this release, and moving to 1.4.3 instead.

Fixed

  • #95 - Removed optional dependencies on sphinx, m2r2, sphinx-rtd-theme, toml.

[1.4.0] - 2022-01-24

WARNING - #90 inadvertently introduced a breaking API change in DiffSync 1.4.0 through 1.4.2 (#101); this change was reverted in #102 for DiffSync 1.4.3 and later. We recommend not using this release, and moving to 1.4.3 instead.

Added

  • #53 - Add a new example based on pynautobot and Nautobot REST API
  • #59 - Add proper documentation published in Read the doc
  • #68 - Cleanup Readme, add link to new documentation site
  • #70 - Add add_or_update() method to DiffSync class that requires a DiffSyncModel to be passed in and will attempt to add or update an existing object
  • #72 - Add core engine section in docs and rename example directories
  • #75 - Add support for Structlog v21 in addition to v20.
  • #80 - Add support for an existing Diff object to be passed to sync_to() & sync_from() to prevent another diff from being calculated.
  • #81 - Add a new example based on PeeringDB
  • #83 - Add support for Python 3.10
  • #87 - Add new model flags : SKIP_UNMATCHED_BOTH, SKIP_UNMATCHED_SRC & SKIP_UNMATCHED_DST to match the behavior of the global flags

Changed

  • #62 - Update CI Token
  • #69 - Replace Travis CI with Github Actions to run unit tests
  • #82 - Update lock file with latest versions.
  • #90 - Convert list of actions (create, update, delete) to proper Enum

Fixed

  • #51 - Update minimum Pydantic version due to security advisory GHSA-5jqp-qgf6-3pvh
  • #63 - Fix type in Readme

[1.3.0] - 2021-04-07

Added

  • #48 - added optional callback argument to diff_from/diff_to/sync_from/sync_to for use with progress reporting.

[1.2.0] - 2020-12-08

Added

  • #45 - minimum Python version lowered from 3.7 to 3.6, also now tested against Python 3.9.

[1.1.0] - 2020-12-01

Added

  • #37 - added sync_complete callback, triggered on sync_from completion with changes.
  • #41 - added summary API for Diff and DiffElement objects.
  • #44 - added set_status() and get_status() APIs so that DiffSyncModel implementations can provide details for create/update/delete logging

Changed

  • Now requires Pydantic 1.7.2 or later
  • #34 - in diff dicts, changed keys src/dst/_src/_dst to - and +
  • #43 - DiffSync.get_by_uids() now raises ObjectNotFound if any of the provided uids cannot be located; DiffSync.get() raises ObjectNotFound or ValueError on failure, instead of returning None.

Fixed

  • #44 - On CRUD failure, do not generate an extraneous "success" log message in addition to the "failed" message

[1.0.0] - 2020-10-23

Initial release