Installation

⚠️ Disclaimer: This is the official Java SDK for GitHub Copilot. This repository treats the official .NET and nodejs SDKs for GitHub Copilot as reference implementations. These SDKS are all officially supported as GitHub open source projects. The Java implementation follows the backward compatibility guarantees offered by the reference implementations. As such this implementation may introduce breaking changes, according to the policy declared by the reference implementations. Use at your own risk.

⚠️ Artifact versioning plan: Releases of this implementation track releases of the reference implementation. For each release of the reference implementation, there may follow a corresponding relase of this implementation with the same number as the reference implementation. Release identifiers of the reference implementation are in the form vMaj.Min.Micro. For example v0.1.32. The corresponding maven version for the release will be Maj.Min.Micro-java.N, where Maj, Min and Micro are the corresponding numbers for the reference impementation release, and N is a monotonically increasing sequence number starting with 0 for each release. See the corrseponding architectural decision record for more information in the docs/adr directory of the source code.

📦 View on Maven Central

📖 Documentation · Javadoc

Maven

<dependency>
    <groupId>com.github</groupId>
    <artifactId>copilot-sdk-java</artifactId>
    <version>0.1.32-java.0</version>
</dependency>

Gradle (Kotlin DSL)

implementation("com.github:copilot-sdk-java:0.1.32-java.0")

Gradle (Groovy DSL)

implementation 'com.github:copilot-sdk-java:0.1.32-java.0'

What's Changed

📦 Other Changes

• Rebrand copilot-sdk-java from community SDK to official GitHub SDK by @edburns in #8
• Add link to reference implementations. by @edburns in #9
• Adopt versioning scheme from adr-002-maven-version-and-reference-implementation-tracking.md by @edburns in #10
• On branch edburns/dd-2794379-cosmetic-post-public-fixes Support adr-002 version number scheme. by @edburns in #11
• On branch edburns/dd-2794379-cosmetic-post-public-fixes Fix ARTIFACT_ID and CHANGELOG unreleased. by @edburns in #12

New Contributors

• @edburns made their first contribution in #8

Full Changelog: https://github.com/github/copilot-sdk-java/commits/v0.1.32-java.0