GitHub Copilot SDK for Java 1.0.1

Installation

⚠️ 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 release 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 implementation release, and N is a monotonically increasing sequence number starting with 0 for each release. See the corresponding architectural decision record for more information in the docs/adr directory of the source code.

📦 [View on Maven Central]((central.sonatype.com/redacted)

📖 [Documentation]((github.github.io/redacted) · [Javadoc]((github.github.io/redacted)

Maven

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

Gradle (Kotlin DSL)

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

Gradle (Groovy DSL)

implementation 'com.github:copilot-sdk-java:1.0.1'

---

Feature: @CopilotExperimental compile-time gate for experimental APIs

Experimental SDK APIs are now guarded by the @CopilotExperimental annotation. Using them causes a compile error by default; opt in by annotating the consuming class or method with @AllowCopilotExperimental, or pass -Acopilot.experimental.allowed=true to the Java compiler. (#1601)

`@AllowCopilotExperimental`
public class MyHandler {
    // may use `@CopilotExperimental` APIs here
}

Feature: open-canvases snapshot on CopilotSession

CopilotSession.getOpenCanvases() now returns the live set of canvas instances open for the session, bringing the Java SDK to parity with the other SDK languages. The snapshot is seeded from the session create/resume response and kept current via session.canvas.opened and session.canvas.closed events. (#1606)

List<OpenCanvasInstance> open = session.getOpenCanvases();

Other changes

• improvement: propagate @Deprecated and experimental @apiNote Javadoc annotations from the schema into generated Java types (#1591)

Generated by Release Changelog Generator · sonnet46 1.8M