Skip to content

Releases: github/copilot-sdk

v1.0.4

25 Jun 02:31
@github-actions github-actions
v1.0.4
e7d2bd3
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

Choose a tag to compare

View all tags
v1.0.4

What's Changed

  • Add experimental multi-provider BYOK registry config across all six SDKs by @stephentoub in #1718
  • [changelog] Add changelog for v1.0.2 by @github-actions[bot] in #1714
  • edburns/java-add-spotless-to-java-coding-skill by @edburns in #1723
  • Add Java low-level tool definition E2E test and skill [1/6] by @edburns in #1721
  • Add Node.js low-level tool-definition E2E test [3/6] by @edburns in #1725
  • Add Go low-level tool-definition E2E test [2/6] by @edburns in #1724
  • Add Python low-level tool-definition E2E test [4/6] by @edburns in #1726
  • Add .NET low-level tool-definition E2E test [6/6] by @edburns in #1728
  • Add Rust low-level tool-definition E2E test [5/6] by @edburns in #1727
  • Fix codegen schema resolution for new @github/copilot package layout by @stephentoub in #1738
  • Update @github/copilot to 1.0.64-1 by @github-actions[bot] in #1739
  • Bump undici from 6.24.1 to 6.27.0 in /scripts/corrections in the npm_and_yarn group across 1 directory by @dependabot[bot] in #1742
  • Add capi.enableWebSocketResponses and provider.transport session options by @dereklegenzoff in #1711
  • Python: switch from bundled CLI wheels to downloading explicitly or at runtime by @SteveSandersonMS in #1744
  • Update @github/copilot to 1.0.64-3 by @github-actions[bot] in #1752
  • HTTP request callback support by @SteveSandersonMS in #1689
  • fix(rust): backdate extracted CLI mtime to stop build.rs self-invalidation by @redsun82 in #1776
  • Address stephentoub review feedback on HTTP request callback support (+ cross-SDK parity) by @SteveSandersonMS in #1775
  • Strong-name sign .NET SDK by @stephentoub in #1778
  • Harden bundled Copilot CLI extraction against corrupt/partial installs by @jmoseley in #1635
  • Clean up HTTP passthrough API by @SteveSandersonMS in #1784
  • Document Java memory section and add Copilot Memory links across SDK READMEs by @Morabbin in #1783
  • Add preamble section and preserve action to SDKs by @MackinnonBuck in #1713
  • fix(nodejs): handle stdio stdin errors by @sjh9714 in #1584
  • docs: add system message customization section to Python README by @Halcyonhal9 in #1066
  • Add embeddedcli.Path() accessor for the resolved CLI path by @tbrady77 in #1677
  • normalize-sharing-prompts-during-iteration by @edburns in #1729
  • Expose exp_assignments injection on session create/resume across all SDKs by @ellismg in #1750
  • Update @github/copilot to 1.0.65 by @github-actions[bot] in #1793
  • Add getBearerToken callback for BYOK providers (Managed Identity) by @SteveSandersonMS in #1748

New Contributors

Full Changelog: v1.0.2...v1.0.4

Contributors

edburns, Morabbin, and 11 other contributors
Loading

rust/v1.0.4

25 Jun 02:31
@github-actions github-actions
rust/v1.0.4
e7d2bd3
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

Choose a tag to compare

View all tags
rust/v1.0.4

What's Changed

  • Add experimental multi-provider BYOK registry config across all six SDKs by @stephentoub in #1718
  • [changelog] Add changelog for v1.0.2 by @github-actions[bot] in #1714
  • edburns/java-add-spotless-to-java-coding-skill by @edburns in #1723
  • Add Java low-level tool definition E2E test and skill [1/6] by @edburns in #1721
  • Add Node.js low-level tool-definition E2E test [3/6] by @edburns in #1725
  • Add Go low-level tool-definition E2E test [2/6] by @edburns in #1724
  • Add Python low-level tool-definition E2E test [4/6] by @edburns in #1726
  • Add .NET low-level tool-definition E2E test [6/6] by @edburns in #1728
  • Add Rust low-level tool-definition E2E test [5/6] by @edburns in #1727
  • Fix codegen schema resolution for new @github/copilot package layout by @stephentoub in #1738
  • Update @github/copilot to 1.0.64-1 by @github-actions[bot] in #1739
  • Bump undici from 6.24.1 to 6.27.0 in /scripts/corrections in the npm_and_yarn group across 1 directory by @dependabot[bot] in #1742
  • Add capi.enableWebSocketResponses and provider.transport session options by @dereklegenzoff in #1711
  • Python: switch from bundled CLI wheels to downloading explicitly or at runtime by @SteveSandersonMS in #1744
  • Update @github/copilot to 1.0.64-3 by @github-actions[bot] in #1752
  • HTTP request callback support by @SteveSandersonMS in #1689
  • fix(rust): backdate extracted CLI mtime to stop build.rs self-invalidation by @redsun82 in #1776
  • Address stephentoub review feedback on HTTP request callback support (+ cross-SDK parity) by @SteveSandersonMS in #1775
  • Strong-name sign .NET SDK by @stephentoub in #1778
  • Harden bundled Copilot CLI extraction against corrupt/partial installs by @jmoseley in #1635
  • Clean up HTTP passthrough API by @SteveSandersonMS in #1784
  • Document Java memory section and add Copilot Memory links across SDK READMEs by @Morabbin in #1783
  • Add preamble section and preserve action to SDKs by @MackinnonBuck in #1713
  • fix(nodejs): handle stdio stdin errors by @sjh9714 in #1584
  • docs: add system message customization section to Python README by @Halcyonhal9 in #1066
  • Add embeddedcli.Path() accessor for the resolved CLI path by @tbrady77 in #1677
  • normalize-sharing-prompts-during-iteration by @edburns in #1729
  • Expose exp_assignments injection on session create/resume across all SDKs by @ellismg in #1750
  • Update @github/copilot to 1.0.65 by @github-actions[bot] in #1793
  • Add getBearerToken callback for BYOK providers (Managed Identity) by @SteveSandersonMS in #1748

New Contributors

Full Changelog: rust/v1.0.2...rust/v1.0.4

Contributors

edburns, Morabbin, and 11 other contributors
Loading

GitHub Copilot SDK for Java 1.0.4

25 Jun 02:34
@github-actions github-actions
java/v1.0.4
f1a840d

Choose a tag to compare

View all tags
GitHub Copilot SDK for Java 1.0.4 Latest
Latest

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.4</version>
</dependency>

Gradle (Kotlin DSL)

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

Gradle (Groovy DSL)

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

Feature: HTTP request callback support

Register a CopilotRequestHandler on the client to intercept every outbound LLM inference HTTP or WebSocket request — for both BYOK and CAPI — and mutate, replace, or fully forward it. Useful for logging, header injection, model substitution, or custom routing. (#1689, #1775, #1784)

final class MyHandler extends CopilotRequestHandler {
    `@Override`
    protected HttpResponse<InputStream> sendRequest(HttpRequest request, CopilotRequestContext ctx) throws Exception {
        HttpRequest mutated = HttpRequest.newBuilder(request, (n, v) -> true)
                .header("X-Debug-Session", ctx.sessionId() == null ? "none" : ctx.sessionId())
                .build();
        return super.sendRequest(mutated, ctx);
    }
}

CopilotClient client = new CopilotClient(
    new CopilotClientOptions().setRequestHandler(new MyHandler()));

Feature: getBearerToken callback for BYOK providers (Managed Identity)

BYOK provider configs now accept a getBearerToken callback so the SDK consumer can resolve bearer tokens (e.g. Azure Managed Identity) on demand. The SDK takes zero Azure SDK dependency — the consumer supplies the callback using any identity library. (#1748)

var provider = new ProviderConfig()
    .setType("openai")
    .setBaseUrl(baseUrl)
    .setGetBearerToken(args -> cred.getToken(ctx).map(AccessToken::getToken).toFuture());

Feature: experimental multi-provider BYOK registry

Register multiple named providers and models on a single session via NamedProviderConfig and ProviderModelConfig. Custom agents can reference provider-qualified model IDs such as "alpha/sonnet". This feature is experimental. (#1718)

Feature: preamble system message section and preserve action

Two new customization options for system message sections. SystemMessageSections.PREAMBLE targets only the identity preamble without affecting its sibling sub-sections (identity and tool_instructions are now documented as section groups). The new preserve action protects an individually-addressable section from a group-level remove. (#1713)

Other changes

  • feature: add optional memory configuration (MemoryConfiguration) to session create and resume (#1617)
  • feature: defer parameter on tool definitions controls eager vs. lazy tool loading ("auto" or "never") (#1632)
  • feature: otlpProtocol telemetry option for configuring OTLP export transport ("http/json" or "http/protobuf") (#1648)
  • feature: ModelBilling.tokenPrices surfaced on public SDK types, exposing per-tier pricing and context window limits (#1633)
  • feature: CapiSessionOptions.enableWebSocketResponses and ProviderConfig.transport for WebSocket transport control on session create/resume (#1711)
  • improvement: call runtime.shutdown during client stop for deterministic OTEL telemetry flush before process cleanup (#1667)
  • improvement: rename SystemPromptSections → SystemMessageSections for cross-SDK consistency; old class deprecated with forRemoval=true (#1683)

New contributors

  • @almaleksia made their first contribution in #1632
  • @dereklegenzoff made their first contribution in #1711
  • @ellismg made their first contribution in #1750

Generated by Release Changelog Generator · sonnet46 2M

Assets 2
Loading

v1.0.2

18 Jun 00:56
@github-actions github-actions
v1.0.2
8789b28
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

Choose a tag to compare

View all tags
v1.0.2

Feature: opt-in memory for sessions

Sessions can now be configured with persistent memory, allowing the agent to recall information across turns. Set memory: { enabled: true } when creating or resuming a session; when omitted the runtime default applies. (#1617)

const session = await client.createSession({
    memory: { enabled: true },
});
var session = await client.CreateSessionAsync(new SessionConfig
{
    Memory = new MemoryConfiguration { Enabled = true }
});

Feature: defer parameter for tool definitions

Tools now support a defer option controlling whether they are pre-loaded eagerly or surfaced lazily through tool search. Use "auto" (the default) to allow lazy loading, or "never" to force pre-loading. (#1632)

defineTool("lookup_issue", {
    description: "Fetch issue details",
    parameters: z.object({ id: z.string() }),
    defer: "auto",
    handler: async ({ id }) => { /* ... */ },
});
var tool = CopilotTool.DefineTool(
    async ([Description("Issue ID")] string id) => { /* ... */ },
    toolOptions: new CopilotToolOptions { Defer = CopilotToolDefer.Auto });

Other changes

  • feature: [All SDKs] add otlpProtocol telemetry option ("http/json" or "http/protobuf") for configuring OTLP export transport (#1648)
  • feature: [All SDKs] surface ModelBilling.tokenPrices on public SDK types, exposing per-tier input/output/cache pricing and context window limits (#1633)
  • improvement: [All SDKs] call runtime.shutdown during normal client stop for deterministic OTEL telemetry flush before process cleanup (#1667)
  • improvement: [Go] thread context.Context through the JSON-RPC request path for proper cancellation support (#1643)
  • improvement: [Java] add getOpenCanvases() to CopilotSession to track currently open canvas instances, matching the other SDKs (#1606)
  • improvement: [Java] rename SystemPromptSections to SystemMessageSections for cross-SDK consistency; old class deprecated with forRemoval=true (#1683)
  • bugfix: [Python] round sub-millisecond durations in to_timedelta_int to avoid serialization errors (#1668)
  • bugfix: [Rust] skip CLI binary download in build.rs when DOCS_RS env var is set (#1660)

New contributors

  • @andyfeller made their first contribution in #1631
  • @almaleksia made their first contribution in #1632
  • @idryzhov made their first contribution in #1668
  • @scottaddie made their first contribution in #1636

Generated by Release Changelog Generator · sonnet46 1.8M

Loading

rust/v1.0.2

18 Jun 00:57
@github-actions github-actions
rust/v1.0.2
8789b28
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

Choose a tag to compare

View all tags
rust/v1.0.2

What's Changed

  • Bump the java-maven-deps group in /java with 3 updates by @dependabot[bot] in #1613
  • Bump the java-codegen-deps group in /java/scripts/codegen with 2 updates by @dependabot[bot] in #1614
  • Add open-canvases snapshot tracking to the Java SDK by @jmoseley in #1606
  • Add docs style instructions for copilot agents by @sunbrye in #1236
  • docs: rename index.md to README.md in docs directories by @andyfeller in #1631
  • Make exit_plan_mode E2E snapshot tolerant of reworded CLI tool result by @stephentoub in #1639
  • Add defer parameter to tool definition by @almaleksia in #1632
  • Make Go JSON-RPC requests context-aware by @qmuntal in #1643
  • Bump esbuild from 0.27.3 to 0.28.1 in /scripts/codegen in the npm_and_yarn group across 1 directory by @dependabot[bot] in #1647
  • Add API docs column to Available SDKs table in README by @Copilot in #1662
  • Update @github/copilot to 1.0.62 by @github-actions[bot] in #1672
  • Add E2E test for session.providerEndpoint.get by @SteveSandersonMS in #1621
  • SDK: add optional memory configuration to session create and resume by @Morabbin in #1617
  • [E2E] session.todos_changed event + readSqlTodosWithDependencies (6 languages) by @SteveSandersonMS in #1622
  • Add graceful runtime shutdown to SDK clients by @stephentoub in #1667
  • fix(python): round sub-millisecond durations in to_timedelta_int by @idryzhov in #1668
  • Add ADR-005: Ergonomic tool definition via annotation processor by @edburns in #1684
  • Add OTLP protocol telemetry options by @loganrosen in #1648
  • Bump esbuild from 0.28.0 to 0.28.1 in /java/scripts/codegen by @dependabot[bot] in #1649
  • Bump the npm_and_yarn group across 2 directories with 2 updates by @dependabot[bot] in #1681
  • Standardize README prerequisites across all SDK languages by @scottaddie in #1636
  • Update .NET SDK contribution prerequisite by @scottaddie in #1678
  • Update @github/copilot to 1.0.63 by @github-actions[bot] in #1686
  • Fix Dependabot security alerts: bump esbuild, tsx, js-yaml by @Copilot in #1685
  • Rename SystemPromptSections → SystemMessageSections for cross-SDK consistency by @edburns in #1683
  • Surface ModelBilling.tokenPrices on public SDK types by @MackinnonBuck in #1633
  • Port shouldUseReplacedIdentitySectionInResponse E2E test to dotnet, go, nodejs, python, and rust by @Copilot in #1691
  • Generate package-info.java for generated packages by @edburns in #1695
  • Update @github/copilot to 1.0.64-0 by @github-actions[bot] in #1697
  • fix: skip CLI download in build.rs when DOCS_RS env var is set by @Copilot in #1660
  • Update Azure managed identity setup docs by @scottaddie in #1712

New Contributors

Full Changelog: rust/v1.0.1...rust/v1.0.2

Contributors

edburns, loganrosen, and 12 other contributors
Loading

v1.0.1

10 Jun 16:55
@github-actions github-actions
v1.0.1
f2e8469
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

Choose a tag to compare

View all tags
v1.0.1

Feature: @CopilotExperimental compile-time gate for Java SDK

The Java SDK now ships a @CopilotExperimental annotation and a JSR 269 annotation processor that causes compilation to fail when experimental SDK APIs are referenced without opting in. Annotate a class or method with @AllowCopilotExperimental, or pass -Acopilot.experimental.allowed=true to the compiler to acknowledge the experimental status. (#1601)

// Opt in at the declaration level
`@AllowCopilotExperimental`
public class MyApp {
    // experimental SDK types and methods may be used here
}
<!-- Or opt in for the entire compilation unit via Maven -->
<compilerArgs>
    <arg>-Acopilot.experimental.allowed=true</arg>
</compilerArgs>

Other changes

  • bugfix: [Node, Python, Go, .NET, Rust] open_canvases snapshot now correctly shrinks when session.canvas.closed is emitted — previously closed canvases were never removed (#1604)
  • bugfix: [Go] generator no longer produces discriminator accessor names that collide with struct field names (#1596)
  • bugfix: [Rust] generator now scopes RPC methods that reference internal schemas as pub(crate) instead of pub (#1596)
  • improvement: [Java] generated types now propagate schema stability and deprecation metadata — experimental items gain @apiNote Javadoc and deprecated items gain @Deprecated (#1591)

Generated by Release Changelog Generator · sonnet46 1.9M

Loading

rust/v1.0.1

10 Jun 16:55
@github-actions github-actions
rust/v1.0.1
f2e8469
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

Choose a tag to compare

View all tags
rust/v1.0.1

What's Changed

  • De-flake builtin_tools E2E tests with a longer send timeout by @stephentoub in #1538
  • Update java README with accurate validation steps by @edburns in #1541
  • Java SDK: Update @github/copilot dependency to ^1.0.57 by @edburns in #1546
  • Edburns/remove pr 1524 test java publish update notes to point to docs by @edburns in #1543
  • java: disable ModeHandlersTest pending snapshot re-recording (#1547) by @edburns in #1548
  • Refine Go SDK pre-GA API surfaces by @qmuntal in #1549
  • Resolve Vitest security alerts by @stephentoub in #1550
  • Fix MCP E2E send wait race by @stephentoub in #1556
  • Cleanup Java README.md by removing outdated sections by @brunoborges in #1558
  • Java: make it so deps are correctly updated at release by @edburns in #1560
  • Preserve Java commit authorship from standalone repo by @edburns in #1561
  • On branch edburns/1511-codeql-quality-and-security by @edburns in #1566
  • Bump the java-maven-deps group in /java with 7 updates by @dependabot[bot] in #1568
  • Normalize shell completion markers in replay proxy by @stephentoub in #1572
  • [java] Update project description and developer information by @brunoborges in #1574
  • Include Java in the @github/copilot version-bump workflow by @edburns in #1576
  • Update Java JaCoCo coverage badge by @github-actions[bot] in #1501
  • Java: Fix items from traversal of Phase 08 checklist. Rust came along for the ride for issue-triage and sdk-consistency-review. by @edburns in #1581
  • Java: adr recording decision to keep everything in one module by @edburns in #1588
  • Edburns/ghcp 1573 java ensure zod metadata shows thru by @edburns in #1591
  • java: eliminate git clone into target/ — use monorepo directly by @edburns in #1592
  • Stop compiling Java in dependency update workflow by @stephentoub in #1594
  • Fix Go and Rust generator edge cases by @stephentoub in #1596
  • Update grep replay snapshot for absolute paths by @stephentoub in #1598
  • Fix flaky SessionFs workspace metadata E2E test by @stephentoub in #1599
  • Update @github/copilot to 1.0.60 by @github-actions[bot] in #1597
  • Handle session.canvas.closed by removing from open_canvases snapshot by @jmoseley in #1604
  • Add @CopilotExperimental compile-time gate for experimental APIs by @edburns in #1601
  • Add E2E coverage for newly added RPC methods across all SDKs by @stephentoub in #1610
  • Update @github/copilot to 1.0.61 by @github-actions[bot] in #1612
  • Java codegen: clean output directory before generating to prevent orphan accumulation by @edburns in #1623

Full Changelog: rust/v1.0.0-beta.12...rust/v1.0.1

Contributors

edburns, brunoborges, and 4 other contributors
Loading

GitHub Copilot SDK for Java 1.0.1

10 Jun 18:32
@github-actions github-actions
java/v1.0.1
1b094f5

Choose a tag to compare

View all tags
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

Loading

v1.0.0

02 Jun 15:00
@github-actions github-actions
v1.0.0
c8f1b33

Choose a tag to compare

View all tags
v1.0.0

What's Changed

Read more

Contributors

edburns, brunoborges, and 23 other contributors
Loading

rust/v1.0.0

02 Jun 15:01
@github-actions github-actions
rust/v1.0.0
c8f1b33

Choose a tag to compare

View all tags
rust/v1.0.0

What's Changed

  • De-flake builtin_tools E2E tests with a longer send timeout by @stephentoub in #1538
  • Update java README with accurate validation steps by @edburns in #1541
  • Java SDK: Update @github/copilot dependency to ^1.0.57 by @edburns in #1546
  • Edburns/remove pr 1524 test java publish update notes to point to docs by @edburns in #1543
  • java: disable ModeHandlersTest pending snapshot re-recording (#1547) by @edburns in #1548
  • Refine Go SDK pre-GA API surfaces by @qmuntal in #1549

Full Changelog: rust/v1.0.0-beta.12...rust/v1.0.0

Contributors

edburns, stephentoub, and qmuntal
Loading