Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Breaking API change in DiffSync 1.4.0 #101

Closed
glennmatthews opened this issue Mar 2, 2022 · 0 comments · Fixed by #102
Closed

Breaking API change in DiffSync 1.4.0 #101

glennmatthews opened this issue Mar 2, 2022 · 0 comments · Fixed by #102

Comments

@glennmatthews
Copy link
Collaborator

Environment

  • DiffSync version: 1.4.0
  • Python version: any

Observed Behavior

#90 introduced a breaking API change in that DiffElement.action changed from a string value to an enum value. This impacts projects such as network-importer (networktocode/network-importer#256) and any other project that is relying on the value of DiffElement.action, such as to implement custom Diff ordering based on the action.

In the short term it may be simplest just to revert the entirety of #90 and cut a new DiffSync release.

Expected Behavior

API to remain stable in minor and patch releases.

Steps to Reproduce

  1. See for example invalid DiffElement - just fresh install of network-importer-3.0.3 network-importer#256
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant