-
Notifications
You must be signed in to change notification settings - Fork 9
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
Request: bump sui-sdk-types
to 0.1.0
minimum
#74
Comments
Yes the versioning scheme that is being used right now ( Eventually, yes, I want to move to a
None of the above is particularly challenging, its mostly just about finding the time to get these things in order. If moving towards |
I've been eyeing cargo-semver-checks and its GH action for a while (for my personal projects). Maybe you'll find it useful |
I could try to work with it as it is, but the cascading version bump behavior I described would make it somewhat unwieldy for us. For context, we run a private Cargo registry and I take SemVer seriously there. We have similar low-level crates that export types used all over the public interface of other libraries. Although rare (because I try to keep them as simple as possible), if there's a SemVer-breaking update to one of them, then the update process takes a little more time |
thanks for the pointer, i'll take a look at this and see how we can fit it into the development/release process.
Understood, this is another reason why this project exists, in that the main sui repo doesn't really take SemVer seriously and I know that there are builders who would prefer a better stability guarantee when bringing in a library. All this to say, we'll work to try and get to a better place as quickly as we can :) |
Since any update to a version
0.0.x
is considered SemVer-breaking, I think it would be reasonable to havesui-sdk-types
bumped to0.1.0
minimum.That way, we can have internal fixes and additions to the public API without dependents having to manually update their
sui-sdk-types
dependency, and in turn having to do a SemVer-breaking update themselves if they export a type fromsui-sdk-types
An example:
A
depends onsui-sdk-types-v0.0.1
and has a functionfoo() -> TypeTag
B
depends onA
andsui-sdk-types-v0.0.1
and uses the return ofA::foo
to constructsui_sdk_types::types::MakeMoveVector
Then:
From<StructTag> for TypeTag
gets added tosui-sdk-types
; it's bumped to0.0.2
A
updatessui-sdk-types
and uses the new conversion internally to create the return forfoo
The problem will be that
A
needs a SemVer-breaking version bump, otherwiseB
will get an type incompatibility error after acargo update
becauseA
is now exporting a newTypeTag
type (0.0.2
) whileB
would still be usingMakeMoveVector
from0.0.1
The text was updated successfully, but these errors were encountered: