Repository navigation
Releases
v2026.3.10.1
This release moves the SDK onto github-rest-client 2026.3.10.6. The SDK's own API is unchanged. If you use the client's types directly, such as agent automations, issue type payloads or the JSON classes, read the client's breaking changes first.
⚠️ Breaking changes
- Client types you use directly:
github-rest-client2026.3.10.6 merged the agent automation types (about 375 per-operation types became 52 shared ones), merged the issue type payloads intoGitHubIssueTypeRequest, and removed the old...github.jsonpackage. Calls made through the SDK are not affected, but code that builds or reads those client types needs the migrations listed in the client release notes. - Unknown enum values no longer throw: 15 client enums now return
UNRECOGNIZEDfromfromWireinstead of throwingIllegalArgumentException. An exhaustiveswitchover these enums needs a branch for it. - Module path: the HTTP transport now lives in
github-client, which comes in through the client.okioandorg.slf4jare no longer on your module path from this library, so declare them if you use them directly.
✨ What's new
Available through the client; the SDK has no wrappers for them yet.
- User issue fields and types:
github.users().issueFields()andgithub.users().issueTypes(). Cloud and GHEC. - Planning statuses:
github.repositories().planningStatuses(). Cloud and GHEC. - Issue status: issues expose
status. Issue statuses are in preview on GitHub.
🔧 Improvements
- Updated to
github-rest-client2026.3.10.6 andcommon-core7. - Argument checks now use the shared
common-corevalidation helpers.
Full Changelog: v2026.3.10.0...v2026.3.10.1
v2026.3.10.0
First release of github-sdk, an immutable object layer over github-rest-client: you work with Repository, Issue, PullRequest and similar objects instead of building client calls by hand. It is new and not yet proven in production. Smoke-tested against the live GitHub API, and covers REST only.
✨ What's new
- Entry point:
GitHubSdk.of(client)wraps aGitHubClient. Authentication, the GitHub product (github.com, Enterprise Cloud, Enterprise Server) and limits stay on the client; the SDK has no configuration of its own. - Immutable objects: every object keeps the response it was built from (
response()), returns GitHub's answer from each change instead of a local copy, and reloads on request withrefresh(). Optionallookups: looking up something that may not exist returns an emptyOptionalon 404.- Lazy lists: listings are single-use streams that fetch pages as you read them, so
limit(10)stops after the first page. - Builders for changes: edits go through
update()builders. - Repositories: create, update, archive, transfer, fork, star and watch; topics, languages, collaborators and invitations, webhooks, deploy keys and Pages.
- Code: branches and branch protection, rulesets, commits, comparisons, files, multi-file commits, refs, tags, releases and their assets, README.
- Issues and pull requests: issues, comments, labels, milestones, reactions, events, sub-issues and dependencies; pull requests, reviews, review comments and merging.
- Actions and CI: workflows, runs, jobs, artifacts, variables, caches, self-hosted runners, check runs, commit statuses, deployments and environments.
- Security: Dependabot, secret scanning and code scanning alerts, code quality, security advisories, dependency graph and SBOM, interaction limits.
- People and organizations: users, the signed-in account, organizations, teams, members and invitations, SSH, GPG and signing keys, notifications and gists.
- Projects and packages: Projects v2 (read and edit items and fields) and GitHub Packages.
- Platform: search, rate limit, events, GitHub Apps and Marketplace, licenses and Markdown rendering.
🔧 Improvements
- Requires Java 21. Ships as the module
io.github.piotr_janczukowicz.githubsdkand also works on the class path. - Depends only on
github-rest-client(built against2026.3.10.5). The version follows the OpenAPI version of the client.
Not covered
Copilot, codespaces, billing, Enterprise Server administration, and anything that needs GraphQL such as discussions. Use github-rest-client directly for the REST ones.
Full Changelog: https://github.com/piotr-janczukowicz/github-sdk/commits/v2026.3.10.0