Skip to content

Releases: github/copilot-sdk

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 Latest
Latest

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
Assets 2
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

GitHub Copilot SDK for Java 1.0.0

02 Jun 15:04
@github-actions github-actions
java/v1.0.0
d80ce1b

Choose a tag to compare

View all tags
GitHub Copilot SDK for Java 1.0.0

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

📖 Documentation · Javadoc

Maven

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

Gradle (Kotlin DSL)

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

Gradle (Groovy DSL)

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

What's Changed

Full Changelog: java/v1.0.0-beta-12-java.1...java/v1.0.0

Contributors

qmuntal
Loading

GitHub Copilot SDK for Java 1.0.0-beta-12-java.1

02 Jun 07:22
@github-actions github-actions
java/v1.0.0-beta-12-java.1
91e3518

Choose a tag to compare

View all tags
GitHub Copilot SDK for Java 1.0.0-beta-12-java.1 Pre-release
Pre-release

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.0-beta-12-java.1</version>
</dependency>

Gradle (Kotlin DSL)

implementation("com.github:copilot-sdk-java:1.0.0-beta-12-java.1")

Gradle (Groovy DSL)

implementation 'com.github:copilot-sdk-java:1.0.0-beta-12-java.1'

Feature: slash command responses accessible via RPC

Applications can now retrieve responses from slash commands. Previously the ability to invoke slash commands existed, but responses were not surfaced through the RPC layer. (#1520)

// Send a slash command and receive its response via the session RPC
CompletableFuture<AssistantMessage> response = session.sendMessage("/my-command args");

Feature: session.mcp.apps.callTool returns JsonNode

session.mcp.apps.callTool() previously returned CompletableFuture<Void> due to a codegen gap; it now correctly returns CompletableFuture<JsonNode>, making the tool result accessible. (#1523)

JsonNode result = session.rpc().mcp().apps().callTool(params).get();

Generated by Release Changelog Generator · ● 2.2M

Loading

v1.0.0-beta.12

01 Jun 21:26
@github-actions github-actions
v1.0.0-beta.12
84a0106
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.0-beta.12 Pre-release
Pre-release

Feature: [Go] idiomatic initialism casing across the Go SDK

All Go identifiers now use idiomatic uppercase initialisms as required by Go conventions. (#1527)

⚠️ Breaking change for Go callers. Key renames include:

  • Api → API, Rpc → RPC, Mcp → MCP, Sse → SSE
  • Url/Uri → URL/URI, Id → ID, Tcp → TCP
  • Ado → ADO, Sdk → SDK, Fs → FS
  • UriConnection → URIConnection, TcpConnection → TCPConnection

Feature: [Go] tri-state session boolean flags

SessionConfig.EnableConfigDiscovery, ResumeSessionConfig.EnableConfigDiscovery, and ResumeSessionConfig.ContinuePendingWork are now *bool instead of bool, allowing callers to express explicit false (opt out) vs. unset (defer to runtime default). (#1536)

⚠️ Breaking change for Go callers. Use copilot.Bool(true) / copilot.Bool(false) to set a value, or leave the field nil to defer to the runtime default.

cfg := copilot.SessionConfig{
    EnableConfigDiscovery: copilot.Bool(false), // explicitly opt out
}

Feature: [Java] slash command responses accessible via RPC

Java callers can now retrieve responses from slash commands via the RPC layer. Previously it was possible to invoke slash commands but not to receive their responses programmatically. (#1520)

Improvement: [Python/Rust] stable public namespaces for generated types

Generated types are no longer exposed under the internal generated sub-module. (#1535)

  • Python: use copilot.session_events.X and copilot.rpc.X instead of copilot.generated.*
  • Rust: use github_copilot_sdk::session_events::X and github_copilot_sdk::rpc::X instead of github_copilot_sdk::generated::*

Other changes

  • bugfix: [Go] fix session event attachment aliases (#1515)
  • bugfix: [Go] preserve empty slices and maps in JSON serialization (#1528)
  • bugfix: [Node] map suppressResumeEvent to disableResume on the wire (#1529)
  • improvement: [Java] map session.mcp.apps.callTool result to JsonNode (#1523)
  • improvement: [Python] derive __version__ from package metadata; align Node version sentinel (#1521)
  • improvement: fix GitHub brand casing across SDK public surface (#1531)

New contributors

  • @dmytrostruk made their first contribution in #1515
  • @willglas made their first contribution in #1529

Generated by Release Changelog Generator · ● 1.4M

Loading