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

bug: asdf does not use semantic versioning #1857

Open
pwillis-oi opened this issue Jan 30, 2025 · 3 comments
Open

bug: asdf does not use semantic versioning #1857

pwillis-oi opened this issue Jan 30, 2025 · 3 comments
Labels

Comments

@pwillis-oi
Copy link

Describe the Bug

Hello,

When version numbers look like "x.y.z" these days, the assumption is that they use semantic versioning.
This then follows that if you use the same major version, there should be no breaking/non-backwards-compatible changes.

For reference: https://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 backward compatible manner
  • PATCH version when you make backward compatible bug fixes
  • Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.

But according to the CHANGELOG, new version 0.16.0 is a complete rewrite which includes breaking/non-backwards-compatible changes.

This version number should be 1.0.0 if semantic versioning is to be followed

Steps to Reproduce

See description

Expected Behaviour

See description

Actual Behaviour

See description

Environment

See description

asdf plugins affected (if relevant)

No response

@pwillis-oi pwillis-oi added the bug label Jan 30, 2025
@jdx
Copy link

jdx commented Jan 30, 2025

semver (according to your own source) doesn't apply for 0.x versions:

Major version zero (0.y.z) is for initial development. Anything MAY change at any time. The public API SHOULD NOT be considered stable.

@pwillis-oi
Copy link
Author

My bad, I didn't realize asdf is not production ready

@Stratus3D
Copy link
Member

As @jdx says 0.x.z is for initial development. It's somewhat common for projects to not ever release a major version and stay as major version zero for many years. Just treat the minor version as the major version (it indicates breaking changes). and the patch version as an indicator of backwards compatible changes.

Now, should we have released asdf as 1.0.0 several years? Probably, it is widely used, and generally, the interface has been pretty stable. Should we release 1.0.0 now? Probably not, given that this is a complete rewrite there will likely be new issues reported in the coming weeks.

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

No branches or pull requests

3 participants