github-api icon indicating copy to clipboard operation
github-api copied to clipboard

Move to version 2.x

Open bitwiseman opened this issue 1 year ago • 1 comments

Description

While 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 to support adding new features. These changes break binary compatibility requiring a major version bump.

v2.0 includes:

  • Dropping support for Java 8
  • Removal of most deprecated classes and methods
  • Removal of all "bridge methods"

Before submitting a PR:

  • [ ] Changes must not break binary backwards compatibility. If you are unclear on how to make the change you think is needed while maintaining backward compatibility, CONTRIBUTING.md for details.
  • [ ] Add JavaDocs and other comments explaining the behavior.
  • [ ] When adding or updating methods that fetch entities, add @link JavaDoc entries to the relevant documentation on https://docs.github.com/en/rest .
  • [ ] Add tests that cover any added or changed code. This generally requires capturing snapshot test data. See CONTRIBUTING.md for details.
  • [ ] Run mvn -D enable-ci clean install site locally. If this command doesn't succeed, your change will not pass CI.
  • [ ] Push your changes to a branch other than main. You will create your PR from that branch.

When creating a PR:

  • [ ] Fill in the "Description" above with clear summary of the changes. This includes:
    • [ ] If this PR fixes one or more issues, include "Fixes #" lines for each issue.
    • [ ] Provide links to relevant documentation on https://docs.github.com/en/rest where possible. If not including links, explain why not.
  • [ ] All lines of new code should be covered by tests as reported by code coverage. Any lines that are not covered must have PR comments explaining why they cannot be covered. For example, "Reaching this particular exception is hard and is not a particular common scenario."
  • [ ] Enable "Allow edits from maintainers".

bitwiseman avatar Jun 22 '24 00:06 bitwiseman

Codecov Report

Attention: Patch coverage is 81.00000% with 19 lines in your changes missing coverage. Please review.

Project coverage is 81.74%. Comparing base (9e9e775) to head (963900f).

Files with missing lines Patch % Lines
...hsuke/github/extras/HttpClientGitHubConnector.java 83.33% 4 Missing and 1 partial :warning:
src/main/java/org/kohsuke/github/GHMyself.java 0.00% 4 Missing :warning:
...ava/org/kohsuke/github/GitHubRateLimitHandler.java 76.47% 3 Missing and 1 partial :warning:
...c/main/java/org/kohsuke/github/GHOrganization.java 25.00% 3 Missing :warning:
...va/org/kohsuke/github/GitHubAbuseLimitHandler.java 90.47% 2 Missing :warning:
src/main/java/org/kohsuke/github/GitHubClient.java 50.00% 0 Missing and 1 partial :warning:
Additional details and impacted files
@@             Coverage Diff              @@
##               main    #1860      +/-   ##
============================================
+ Coverage     81.36%   81.74%   +0.37%     
+ Complexity     2465     2303     -162     
============================================
  Files           239      231       -8     
  Lines          7475     6967     -508     
  Branches        402      376      -26     
============================================
- Hits           6082     5695     -387     
+ Misses         1146     1038     -108     
+ Partials        247      234      -13     

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

codecov[bot] avatar Jun 23 '24 19:06 codecov[bot]