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

Semver compliancy #541

Closed
medikoo opened this issue Jun 2, 2021 · 4 comments
Closed

Semver compliancy #541

medikoo opened this issue Jun 2, 2021 · 4 comments

Comments

@medikoo
Copy link

medikoo commented Jun 2, 2021

Does this package follow semver?

If so, what were the breaking changes introduced with v10?

Changelog is silent on that

@motdotla
Copy link
Owner

motdotla commented Jun 2, 2021

We follow as closely as possible but sometimes we get it wrong.

This time we chose to upgrade because of the added ~ home path feature. That was the major change for v10.

@motdotla motdotla closed this as completed Jun 2, 2021
@medikoo
Copy link
Author

medikoo commented Jun 5, 2021

This time we chose to upgrade because of the added ~ home path feature. That was the major change for v10.

Ok, so per semver rules it technically should go as another 9.x release (as there was nothing breaking introduced)

It'll be good to outline in CHANGELOG that v10 comes with no breaking changes, otherwise it's really confusing.

@dscalzi
Copy link

dscalzi commented Jun 7, 2021

I agree, this issue saved me spending a ton of time trying to find the breaking changes. The reason for a semver-major increment should be noted clearly on the changelog.

@actuallymentor
Copy link

Please actually use semver. This is a great package, but not respecting semver gives a lot of "oh shit there are breaking changes" anxiety.

@motdotla adding ~ as an option is not a major change, it is a minor change according to semver.

From semver.org:

Given a version number MAJOR.MINOR.PATCH, increment the:

MAJOR version when you make incompatible API changes,
MINOR version when you add functionality in a backwards compatible manner, and
PATCH version when you make backwards compatible bug fixes.
Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.

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

4 participants