hirosystems
Automatically add "event replay or genesis sync required" note to CHANGELOG when necessary
For every new API release, we have to manually determine whether or not users would need to perform an event replay or full genesis sync to use the newer version (if anything from the DB changes). Furthermore, we have to add this note to the CHANGELOG by hand to let them know.
Ideally, we could set a rule to the CHANGELOG generator that detects changes in the /src/migrations directory to add this note automatically.
Ideally, we could set a rule to the CHANGELOG generator that detects changes in the /src/migrations directory to add this note automatically.
This sounds like a good approach. We could also cut a 1.0 release and start using semver, then have the API store its version in pg, and on startup, it can check for incompatible previous API version, log a useful error with some pointers/instructions to event-replay, and exit.
This can be completed by using the semantic-release/exec plugin. Adding an exec entry between these two lines which runs a script or command would take care of it.
