search

philschatz / octokat.js

:octocat: Github API Client using Promises or callbacks. Intended for the browser or NodeJS.
http://philschatz.com/2014/05/25/octokat/
MIT License
421 stars 133 forks source link

Changelog / breaking changes? #182

Open gmaclennan opened 7 years ago

gmaclennan commented 7 years ago

Just looking at updating some modules that use this to v0.9.0 from v0.6.0. Should I consider minor version bumps breaking changes? Is there a changelog anywhere I am missing? I looked through the commit log but could not see a clear indication of breaking changes. Would it be possible to briefly list any breaking changes?

philschatz commented 7 years ago

Thanks for checking! There is not explicit changelog yet, but any help with creating a (semi) automated one would be appreciated.

Until 1.0 the minor version updates should be considered as breaking changes.

Up to, but not including 0.9, most of the breaking changes have been in less-popular parts of GitHub's API so your code may not be affected.

In 0.9 however, octokat switched to using the Fetch API which requires a polyfill if used in older browsers or Internet Explorer.

I will try to post a Roadmap to increase visibility into planned changes moving forward.

If you notice any problems upgrading please comment on this issue or file a new one (if this Issue is closed).