Skip to content
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

Breaking API Changes #76

Closed
pkandrashkou opened this issue Dec 27, 2021 · 1 comment
Closed

Breaking API Changes #76

pkandrashkou opened this issue Dec 27, 2021 · 1 comment

Comments

@pkandrashkou
Copy link

pkandrashkou commented Dec 27, 2021

Hello @pietbrauer. I think it would have been better to release changes from 2.5.0 as a major version bump as of now it breaks some projects such as https://github.com/nerdishbynature/octokit.swift and https://github.com/danger/swift.

I could not find any issues related to this yet, but I can see that the release is still quite fresh, so I assume this is not only my local issue.

I think the main reason is the deletion of the Response structure here. However, I am not 100% sure this is the only breaking change because I have not investigated it further and as far as I can see there are quite a lot of changes apart from that one.

Nevertheless, I think another part of the story is that these projects use RequestKit as a dependency with package(name:url:from:) and the Apple Documentation states:

Adds a package dependency that uses the version requirement, starting with the given minimum version, going up to the next major version.

Personally, I think it would be better to revert and re-release the RequestKit to save the trouble for other developers changing their Package.swift files to pin the 2.3.0 release or updating their the usage code to the new API which is more time-consuming tbh 🙂

Please let me know if more information is required from my side. I would be glad to help.

Originally posted by @pkondrashkov in #75 (comment)

@pietbrauer
Copy link
Member

I revoked the 2.5.0 release and will re-release as 3.0.0. Sorry for the trouble.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants