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

Should document ispyb-database version requirement #219

Open
jlmuir opened this issue Apr 15, 2021 · 2 comments
Open

Should document ispyb-database version requirement #219

jlmuir opened this issue Apr 15, 2021 · 2 comments

Comments

@jlmuir
Copy link
Contributor

jlmuir commented Apr 15, 2021

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.

@KarlLevik
Copy link
Member

KarlLevik commented Nov 29, 2023

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.

@ndg63276
Copy link
Collaborator

ndg63276 commented Dec 6, 2023

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).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants