Changelog?

[grantmcconnaughey]

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.

[greg-db]

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

[goodspark]

Ping on this. Please provide a changelog

[greg-db]

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

[goodspark]

Oh nice! Thanks

[chingc]

@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.

[greg-db]

@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 )

[chingc]

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

[ChrisRut]

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

[greg-db]

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

[ChrisRut]

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

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 #52 (comment)

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

I figured it's worth asking for confirmation.

[greg-db]

@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.