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

STRAMBIO/RIGANO -- Model Versioning Proposal #86

Open
strambc opened this issue Oct 12, 2022 · 3 comments
Open

STRAMBIO/RIGANO -- Model Versioning Proposal #86

strambc opened this issue Oct 12, 2022 · 3 comments
Assignees
Labels
enhancement Proposal for enhancement help wanted Extra attention is needed question Further information is requested

Comments

@strambc
Copy link
Member

strambc commented Oct 12, 2022

4DN-BINA-OME model versioning

@strambc strambc added enhancement Proposal for enhancement help wanted Extra attention is needed question Further information is requested labels Oct 12, 2022
@strambc
Copy link
Member Author

strambc commented Oct 12, 2022

@andreacosolo @dsudar what do you guys think of this versioning proposal?

@andreacosolo
Copy link

While I see what we're trying to achieve here, I continue to have doubts regarding the proposal of a versioning scheme that differs from a standard one, such as semantic versioning. In addition, I think the proposed plan is lacking modularity, which appears to be already a problem (as indicated by the question about extensions, for example) and can only get worse as the overall project grows.

My alternative suggestion would be to:

  1. Clearly separate each project, e.g. the model, each of its extensions, each of its serializations.
  2. Use semantic versioning for each project.
  3. Keep track of dependencies.

For example, you might want to include a file in the serialization project that records its current version, the version of the model it is based on, and the version of any model extension that is relevant.
Depending on the project, it could pin one specific version of one particular dependency, or be compatible with a range of versions, or with a range of versions that do not cross a major or minor version boundary.

@strambc
Copy link
Member Author

strambc commented Oct 12, 2022

Just to clarify, the versioning proposal above only would apply to how to handle the Model Version vs. the Version of a given Serialization (e.g., different JSON Schema representation versions of the same Model).

@WU-BIMAC WU-BIMAC deleted a comment from andreacosolo Oct 13, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Proposal for enhancement help wanted Extra attention is needed question Further information is requested
Projects
None yet
Development

No branches or pull requests

3 participants