Should document ispyb-database version requirement
Opened this issue · 2 comments
SynchWeb should clearly document which version of ispyb-database it requires (e.g., "ispyb-database 1.20.0 or later"). This should be done in the same way that most programs and libraries document their dependencies. Without this, I'm left guessing and trying things like using the latest from the master branch of the SynchWeb and ispyb-database repos, or using snapshots from the SynchWeb and ispyb-database repos that are approximately from the same point in time.
Hard to disagree with this.
Most database changes are backwards compatible, though, so you could just use the most recent ispyb-database version, and SynchWeb would be fine, even if you were using an older SynchWeb version.
Although, backwards-incompatible database changes do happen, occasionally. But this is usually indicated by its semantic versioning.
After an internal discussion, we think we could maybe put this information in the release notes for each release, and also in the suggest section of the api/composer.json file (https://getcomposer.org/doc/04-schema.md#suggest).