Download Latest Version v2.0-rc.3 source code.tar.gz (6.3 MB)
Email in envelope

Get an email when there's a new version of Java API for GitHub

Home / github-api-2.0-rc.3
Name Modified Size InfoDownloads / Week
Parent folder
README.md 2025-04-13 2.1 kB
v2.0-rc.3 source code.tar.gz 2025-04-13 6.3 MB
v2.0-rc.3 source code.zip 2025-04-13 12.8 MB
Totals: 3 Items   19.1 MB 0

Major version bump to v2.x

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.

Breaking changes since 2.0-rc.1

Migrate legacy date-time api to new date-time api @solonovamax (#2074)

Not sure that this was absolutely necessary, but it forced a discussion of how we'd should requests for targeted breaking changes.

The result was the re-enabling of bridge method generation, but this time with a github-api-bridged artifact. My thought here is to guarantee binary compatibility for github-api-bridged on a rolling 12-month basis. The project may

Cleanup names and enforce naming conventions @bitwiseman (#2084)

This change cleans up the names for all fields to remove underscores. This is considered a binary breaking change because objects that were serialized before this release will not be deserializable to this release (and visa versa). I'm not sure if this this is a scenario we need to be conscious of but it can be discussed further if it comes up.

Other Breaking changes

Technical debt

  • Drop support for Java 8
  • Remove functional dependencies on HttpURLConnection
  • Remove most deprecated classes and methods
  • Remove all existing "bridge methods"

Publish bridged artifact

To continue to support binary backward compatibility while also minimizing drag for users that do not require it, we have moved bridge methods to a github-api-bridged artifact.

Other Improvements

  • Test clean up
  • Site generation updates
  • First GraphQL endpoint (Thanks @seate)
  • Lower memory consumption by using streaming response body for successful requests (Thanks @atsushieno)

Changes in this release

Changes

  • Cleanup names and enforce naming conventions @bitwiseman (#2084)
  • Re-enable japicmp enforcement @bitwiseman (#2086)
Source: README.md, updated 2025-04-13