search

xanzy / go-gitlab

GitLab Go SDK
Apache License 2.0
2.37k stars 940 forks source link

Breaking changes not documented #1988

Closed makkes closed 2 weeks ago

makkes commented 4 weeks ago

The Flux project had a hard time today bumping go-gitlab to its latest version because https://github.com/xanzy/go-gitlab/commit/f49ba027968b5a34c4f925e885c91a09e50a16df apparently broke the API as the original HTTP error isn't returned anymore.

I would like to start a discussion on documenting such breaking changes somewhere going forward. Many projects do this in the release notes, others in a dedicated CHANGELOG.md file.

svanharmelen commented 3 weeks ago

Hi @makkes, I'm sorry this change caused issues for you 😞

I fully understand its not cool to ship breaking changes without people being able to easily see what changed so they can update the relevant bits without having to investigate issues themselves.

So I'm open to start using releases instead of just tags and add some bits to indicate any breaking changes that might be in that release. Hope that will improve things going forward...

svanharmelen commented 2 weeks ago

I'm not 100% sure I got all the breaking changes in the v0.108.0 release, but will try to keep track of any breaking changes that are getting merged from now on...

makkes commented 2 weeks ago

Thank you so much @svanharmelen!