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

Add a task ashCheckPersistenceSchemaCompatibility (?) sbt task that would fail on unhandled changes to API #140

Open
PawelLipski opened this issue Dec 5, 2021 · 0 comments
Labels
event/state compatibility Relates to maintaining compatibility of akka-persistence events/state feature New feature or request nice to have Not very strictly needed for ASH to be usable

Comments

@PawelLipski
Copy link
Collaborator

Currently, there's only ashDumpPersistenceSchema and this only dumps the schema to a file, and it's down to the user to verify that there are no changes (when comparing to e.g. develop branch).

This could be automated even more within this plugin, I can see the following steps can be undertaken:

  1. the dump can be saved somewhere in the repository (project/ folder? src/<something>/resources/?) and tracked under git — this way the sbt plugin itself will be able to detect the changes, without reliance on e.g. external CI artifacts
  2. then, to mark the difference as resolved, the user just needs to replace the existing persistence schema file with the new version (after probably adding necessary schema migrations!)

TBD whether this sbt task should be aware of schema migrations in any way.

@PawelLipski PawelLipski added feature New feature or request event/state compatibility Relates to maintaining compatibility of akka-persistence events/state labels Dec 5, 2021
@PawelLipski PawelLipski changed the title Add a task ashCheckPersistenceSchemaCompatibilty (?) sbt task that would fail on unhandled changes to API Add a task ashCheckPersistenceSchemaCompatibility (?) sbt task that would fail on unhandled changes to API Jun 10, 2022
@PawelLipski PawelLipski added the nice to have Not very strictly needed for ASH to be usable label Jun 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
event/state compatibility Relates to maintaining compatibility of akka-persistence events/state feature New feature or request nice to have Not very strictly needed for ASH to be usable
Projects
None yet
Development

No branches or pull requests

1 participant