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

Figure out a v2 strategy #10

Open
displague opened this issue Mar 11, 2022 · 0 comments
Open

Figure out a v2 strategy #10

displague opened this issue Mar 11, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation question Further information is requested

Comments

@displague
Copy link
Member

displague commented Mar 11, 2022

Several API changes have been to the backing API and the Go SDK. Some fields are persisting in the SDK, and are (in some cases) no longer provided by the API. Some SDK structures would benefit from refactoring.

Because this client is a semver v1 client, our breaking changes will need to be released with consideration of Go Module v2 semantics:
https://go.dev/doc/modules/release-workflow#breaking
https://go.dev/blog/module-compatibility
https://codeengineered.com/blog/2019/go-mod-major-versions/

https://github.com/equinix/ne-go#purpose should define the deprecation patterns used and the versioning strategy.

Once ready - we should publish a v2 with the deprecated fields removed.

This was previously discussed in #4 (comment)

@displague displague added documentation Improvements or additions to documentation question Further information is requested labels Mar 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation question Further information is requested
Projects
None yet
Development

No branches or pull requests

1 participant