-
Notifications
You must be signed in to change notification settings - Fork 49
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
Plan for go-log releases #68
Comments
//cc @Stebalien @Kubuxu @raulk @frrist @vyzo |
Note: once 1.0.0 has been tagged, I will go through and update all the PRs I have open against libp2p and ipfs to use 1.0.0 go-log package. |
IMO, switching to 2.0.0 at this point is worse than just leaving a deprecated If we're worried about calls to the deprecated |
At this point, all instances of |
@Stebalien @lanzafame what if we did a patch version bump? #67 would be |
That would work but, honestly, it doesn't really matter any which way. @lanzafame has convinced me that a major version bump isn't really an issue and we should be less scared of them. |
Plan has been implemented. |
With the upcoming deprecation of the current go-log interface, I thought it best if we spell out what the releases are going to be and how they will interact with go modules and what any end-users will want to do to stay where they are or move forward.
Current release: 0.0.1
The current release
0.0.1
simply adds go modules support to go-log.Transition release: 1.0.0
Because go modules has a special meaning assigned to versions 0.x.x and 1.x.x, any new package will import the latest version of go-log, so to prevent surprising users with broken code, I propose that we make 1.0.0 be the current master branch plus #67. This way 1.0.0 will contain both old and new APIs in full.
Only New API release: 2.0.0
To ensure that we don't break anyone's code by accident, I propose that the codebase represented by #65, will be tagged as 2.0.0. This is because go mod considers this to be a separate package entirely from the 0.x.x->1.x.x package. 2.0.0 will only contain the new API which has the zap logging package as it's backend.
Step by step plan
The text was updated successfully, but these errors were encountered: