dropbox-sdk-python icon indicating copy to clipboard operation
dropbox-sdk-python copied to clipboard

Changelog?

Open grantmcconnaughey opened this issue 9 years ago • 11 comments

Is there a Changelog for the new SDK? The releases seem to be coming rapidly. I'm using dropbox 2.2.0, but versions 3, 4, and 5 have come out recently and there is no way to know what changes they contain. I don't know if I should upgrade or not, and if I do upgrade what changes I should make.

Is there a Changelog anywhere? And if not, I would like to request one.

grantmcconnaughey avatar Feb 12 '16 15:02 grantmcconnaughey

We don't currently have a changelog file for the Python SDK, but I'll be sure to pass this along as feedback.

You can refer to the commit messages for information on what changed though: https://github.com/dropbox/dropbox-sdk-python/commits/master

greg-db avatar Feb 12 '16 18:02 greg-db

Ping on this. Please provide a changelog

goodspark avatar May 09 '19 16:05 goodspark

@goodspark Thanks for the note! The team uses the release notes and commit history instead of a changelog file, so please refer to those.

greg-db avatar May 09 '19 16:05 greg-db

Oh nice! Thanks

goodspark avatar May 09 '19 16:05 goodspark

@greg-db Commit history is good for the project developers that already know the context of the changes, but for developers outside of the project it might not always contain enough information.

I think the main thing users are concerned with are breaking changes. If details of any breaking changes could be added to the release notes that would be tremendously helpful.

chingc avatar Jul 12 '19 14:07 chingc

@chingc Thanks for the feedback!

We try to avoid breaking changes, but for reference, the Dropbox SDKs follow semver, so any potentially breaking changes should be accompanied by a bump to the major revision, with an indication of what changed in the release notes. (For example, when we removed the old API v1 methods: https://github.com/dropbox/dropbox-sdk-python/releases/tag/v8.0.0 )

greg-db avatar Jul 12 '19 14:07 greg-db

@greg-db Thanks, that's good to know!

chingc avatar Jul 12 '19 14:07 chingc

Where are the release notes for https://github.com/dropbox/dropbox-sdk-python/releases/tag/v10.0.0

Screen Shot 2020-04-16 at 8 19 44 AM Screen Shot 2020-04-16 at 8 42 56 AM

ChrisRut avatar Apr 16 '20 12:04 ChrisRut

@ChrisRut Thanks for checking in on this. The release notes for this new release are still in the works.

greg-db avatar Apr 16 '20 14:04 greg-db

Thanks @greg-db I see the release notes have now been updated: https://github.com/dropbox/dropbox-sdk-python/releases/tag/v10.0.0

Screen Shot 2020-04-16 at 2 46 48 PM

Is it safe to assume there aren't any breaking changes with this jump from 9.x to 10.x? There is nothing in the release notes that says anything about breaking changes, but given your comment here https://github.com/dropbox/dropbox-sdk-python/issues/52#issuecomment-510910773

so any potentially breaking changes should be accompanied by a bump to the major revision

I figured it's worth asking for confirmation.

ChrisRut avatar Apr 16 '20 18:04 ChrisRut

@ChrisRut There are actually a few small breaking changes. We just finished updating the release notes accordingly. Apologies that wasn't all updated at once.

greg-db avatar Apr 16 '20 19:04 greg-db