Skip to content

Restore API compatibility with 5.5.0 and earlier releases #1156

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

Closed

Conversation

MarkEWaite
Copy link

Restore API compatibility with 5.5.0 and earlier releases

224f4c5#commitcomment-145297850 notes that the change from boolean to Boolean is a breaking change in the API.

It seems easiest and safest to restore API compatibility rather than requiring lock-step upgrades from consumers of the API. Jenkins (as an example) allows users to upgrade the GitLab API plugin without requiring that they upgrade the GitLab branch source plugin. When that happens, the breaking change in the API causes runtime failures for Jenkins users.

jenkinsci/gitlab-branch-source-plugin#435 reports some of those runtime failures.

JENKINS-73672 reports more runtime failures due to the breaking change in the API.

Fixes #1155

gitlab4j@224f4c5#commitcomment-145297850
notes that the change from boolean to Boolean is a breaking change in
the API.

It seems easiest and safest to restore API compatibility rather than
requiring lock-step upgrades from consumers of the API.  Jenkins (as an
example) allows users to upgrade the GitLab API plugin without requiring
that they upgrade the GitLab branch source plugin.  When that happens,
the breaking change in the API causes runtime failures for Jenkins users.

jenkinsci/gitlab-branch-source-plugin#435
reports some of those runtime failures.

https://issues.jenkins.io/browse/JENKINS-73672 reports more runtime
failures due to the breaking change in the API.

Fixes gitlab4j#1155
@basil
Copy link

basil commented Aug 27, 2024

@MarkEWaite Note that as of jenkinsci/gitlab-branch-source-plugin#438 we're actually depending on the new signature 😬

@MarkEWaite
Copy link
Author

Closing this pull request so that it won't be merged.

@MarkEWaite MarkEWaite closed this Aug 27, 2024
@MarkEWaite MarkEWaite deleted the restore-5.5.0-api-compatibility branch August 27, 2024 17:51
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

Successfully merging this pull request may close these issues.

5.6.0 includes a breaking change in the API
2 participants