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

docs: update installation version to be less strict #20

Closed
wants to merge 1 commit into from

Conversation

Ziinc
Copy link
Collaborator

@Ziinc Ziinc commented Jan 4, 2024

This updates readme to be less strict

@hauleth
Copy link
Contributor

hauleth commented Jan 4, 2024

That is not correct, as it is against SemVer that we are using there.

@Ziinc
Copy link
Collaborator Author

Ziinc commented Jan 4, 2024

It's so that users who attempt to install will get the highest minor version and latest features. If they need to pin a specific minor version then it is up to them to add the patch number

@hauleth
Copy link
Contributor

hauleth commented Jan 4, 2024

I think that we should provide the meaningful value in the README.md. Just as with stable libraries you see ~> 3.1 not ~> 3 in installation instructions. We (through SemVer) guarantee that 0.2.0 and 0.2.99 will not introduce any breaking changes, but we do not guarantee that 0.2.1 and 0.3.0 will behave the same way. We can cause breaking changes between these two which will break user expecations. If you want what you have described there, then we can simply put >= 0.0.0 there and call it a day. It will be the same "users who attempt to install will get the highest minor version".

@Ziinc
Copy link
Collaborator Author

Ziinc commented Jan 4, 2024

I'm fine with keeping it strict, just makes it a little more tedious to keep the readme up to date.
In any case, 0.x.y semver is not guaranteed to be stable, so it is not the same as >= 0.0.0 as breaking changes are to be expected with a mix deps.update.

@Ziinc Ziinc closed this Jan 4, 2024
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

Successfully merging this pull request may close these issues.

2 participants