search

gitlab4j / gitlab4j-api

GitLab4J API (gitlab4j-api) provides a full featured Java client library for working with GitLab repositories via the GitLab REST API
MIT License
1.07k stars 463 forks source link

Restore API compatibility with 5.5.0 and earlier releases #1156

Closed MarkEWaite closed 3 months ago

MarkEWaite commented 3 months ago

Restore API compatibility with 5.5.0 and earlier releases

https://github.com/gitlab4j/gitlab4j-api/commit/224f4c5b9f15d54ad3efa6702009e6d99c0445fd#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.

https://github.com/jenkinsci/gitlab-branch-source-plugin/issues/435 reports some of those runtime failures.

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

Fixes https://github.com/gitlab4j/gitlab4j-api/issues/1155

basil commented 3 months ago

@MarkEWaite Note that as of https://github.com/jenkinsci/gitlab-branch-source-plugin/pull/438 we're actually depending on the new signature :grimacing:

MarkEWaite commented 3 months ago

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