-
Notifications
You must be signed in to change notification settings - Fork 736
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
Begin 2.x release train #1935
Begin 2.x release train #1935
Conversation
963900f
to
84024d0
Compare
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #1935 +/- ##
============================================
+ Coverage 81.36% 82.61% +1.24%
+ Complexity 2465 2323 -142
============================================
Files 239 231 -8
Lines 7475 6977 -498
Branches 402 376 -26
============================================
- Hits 6082 5764 -318
+ Misses 1146 975 -171
+ Partials 247 238 -9 ☔ View full report in Codecov by Sentry. |
84024d0
to
048b84b
Compare
52a3bdd
to
bb51e63
Compare
bb51e63
to
9f172d3
Compare
cd5d951
to
b868261
Compare
/** | ||
* Retrieves all the pull requests of a particular state. | ||
* | ||
* @param state | ||
* the state | ||
* @return the pull requests | ||
* @throws IOException | ||
* the io exception | ||
* @see #listPullRequests(GHIssueState) #listPullRequests(GHIssueState) | ||
*/ | ||
public List<GHPullRequest> getPullRequests(GHIssueState state) throws IOException { | ||
return queryPullRequests().state(state).list().toList(); | ||
} | ||
|
||
/** | ||
* Retrieves all the pull requests of a particular state. | ||
* | ||
* @param state | ||
* the state | ||
* @return the paged iterable | ||
* @deprecated Use {@link #queryPullRequests()} | ||
*/ | ||
@Deprecated | ||
public PagedIterable<GHPullRequest> listPullRequests(GHIssueState state) { | ||
return queryPullRequests().state(state).list(); | ||
} | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ihrigb
Noted that this was not marked as Deprecated.
Did a search on usages:
https://github.com/search?q=org%3Ajenkinsci+getPullRequests+path%3A%2F%5Esrc%5C%2Fmain%5C%2Fjava%5C%2F%2F+org.kohsuke.github&type=code
It looks like there's at least one usage in the wild, and since it is in Jenkins it will cause breaks for some time to come.
https://github.com/jenkinsci/ghprb-plugin/blob/master/src/main/java/org/jenkinsci/plugins/ghprb/GhprbRepository.java#L145
There's a similar one for listPullRequests().
Might consider bringing these back at least as bridge methods to not break Jenkins plugins. On the other hand this is a 2.0, accepting some breakages might be acceptable.
Description
I would love for github-api v2.x to be a larger change that has major new features.
However, the most pressing need is clearing technical debt for better stability and ease of adding new features. These changes break binary compatibility requiring a major version bump.
v2.0 includes:
Before submitting a PR:
@link
JavaDoc entries to the relevant documentation on https://docs.github.com/en/rest .mvn -D enable-ci clean install site
locally. If this command doesn't succeed, your change will not pass CI.main
. You will create your PR from that branch.When creating a PR: