Skip to content

Commit fc3a0c6

Browse files
edburnsedburns
authored
Merge pull request #237 from github/edburns/pr-1483-backsync
backport github/copilot-sdk#1483
2 parents 6a1153a + 1f46ecf commit fc3a0c6

27 files changed

Lines changed: 1597 additions & 202 deletions

‎.github/actions/test-report/action.yml‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ inputs:
44
report-path:
55
description: "Path to the test report XML files (glob pattern)"
66
required: false
7-
default: "target/surefire-reports*/TEST-*.xml"
7+
default: "target/{surefire-reports*,failsafe-reports}/TEST-*.xml"
88
jacoco-path:
99
description: "Path to the JaCoCo XML report"
1010
required: false
@@ -17,13 +17,17 @@ inputs:
1717
description: "Name for the check run"
1818
required: false
1919
default: "Java SDK Test Results"
20+
title:
21+
description: "Title for the test report summary"
22+
required: false
23+
default: "Copilot Java SDK :: Test Results"
2024
runs:
2125
using: "composite"
2226
steps:
2327
- name: Generate Test Summary
2428
shell: bash
2529
run: |
26-
echo "## 🧪 Copilot Java SDK :: Test Results" >> $GITHUB_STEP_SUMMARY
30+
echo "## 🧪 ${{ inputs.title }}" >> $GITHUB_STEP_SUMMARY
2731
echo "" >> $GITHUB_STEP_SUMMARY
2832
2933
if ls ${{ inputs.report-path }} 1>/dev/null 2>&1; then
@@ -148,7 +152,7 @@ runs:
148152
if [ -f "$JACOCO_CSV" ]; then
149153
extract_instruction_scope() {
150154
local scope=$1
151-
awk -F',' -v scope="$scope" -v generated_prefix="com.github.copilot.sdk.generated" '
155+
awk -F',' -v scope="$scope" -v generated_prefix="com.github.copilot.generated" '
152156
NR > 1 {
153157
is_generated = index($2, generated_prefix) == 1
154158
if ((scope == "generated" && is_generated) ||

‎.github/workflows/build-test.yml‎

Lines changed: 55 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ jobs:
3030
COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }}
3131

3232
java-sdk:
33-
name: "Java SDK Tests"
33+
name: "Java SDK Tests (JDK ${{ matrix.test-jdk }})"
3434
needs: smoke-test
3535
if: ${{ always() && needs.smoke-test.result != 'failure' }}
3636
permissions:
@@ -39,23 +39,40 @@ jobs:
3939
pull-requests: write
4040

4141
runs-on: ubuntu-latest
42+
strategy:
43+
fail-fast: false
44+
matrix:
45+
test-jdk: ["25", "17"]
4246
defaults:
4347
run:
4448
shell: bash
4549
steps:
4650
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
4751
with:
4852
persist-credentials: false
49-
- uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6
50-
with:
51-
node-version: 22
53+
5254
- uses: actions/setup-java@be666c2fcd27ec809703dec50e508c2fdc7f6654 # v5
5355
with:
54-
java-version: "17"
56+
java-version: "25"
5557
distribution: "microsoft"
5658
cache: "maven"
5759

60+
- uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6
61+
with:
62+
node-version: 22
63+
64+
- name: Build SDK and set up test harness
65+
run: mvn test-compile jar:jar
66+
67+
- name: Verify Javadoc generation
68+
if: matrix.test-jdk == '25'
69+
run: mvn javadoc:javadoc -q
70+
71+
- name: Verify CLI works
72+
run: node target/copilot-sdk/nodejs/node_modules/@github/copilot/index.js --version
73+
5874
- name: Run spotless check
75+
if: matrix.test-jdk == '25'
5976
run: |
6077
mvn spotless:check
6178
if [ $? -ne 0 ]; then
@@ -64,30 +81,27 @@ jobs:
6481
fi
6582
echo "✅ spotless:check passed"
6683
67-
- name: Build SDK and clone test harness
68-
run: mvn test-compile
69-
70-
- name: Verify Javadoc generation
71-
run: mvn javadoc:javadoc -q
72-
73-
- name: Install Copilot CLI from cloned SDK
74-
id: setup-copilot
75-
run: |
76-
# Install dependencies in the cloned SDK's nodejs directory
77-
# This ensures we use the same CLI version as the test harness expects
78-
cd target/copilot-sdk/nodejs
79-
npm ci --ignore-scripts
80-
echo "path=$(pwd)/node_modules/@github/copilot/index.js" >> $GITHUB_OUTPUT
84+
- name: Run Java SDK tests (JDK 25)
85+
if: matrix.test-jdk == '25'
86+
env:
87+
CI: "true"
88+
run: mvn verify -Dskip.test.harness=true
8189

82-
- name: Verify CLI works
83-
run: node ${{ steps.setup-copilot.outputs.path }} --version
90+
- name: Switch to JDK 17
91+
if: matrix.test-jdk == '17'
92+
uses: actions/setup-java@be666c2fcd27ec809703dec50e508c2fdc7f6654 # v5
93+
with:
94+
java-version: "17"
95+
distribution: "microsoft"
8496

85-
- name: Run Java SDK tests
97+
- name: Run Java SDK tests (JDK 17, no recompilation)
98+
if: matrix.test-jdk == '17'
8699
env:
87100
CI: "true"
88-
COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }}
89-
COPILOT_CLI_PATH: ${{ steps.setup-copilot.outputs.path }}
90-
run: mvn verify
101+
run: |
102+
echo "Running tests against JDK 25-built classes using JDK 17 runtime..."
103+
java -version
104+
mvn jacoco:prepare-agent@wire-up-coverage-instrumentation antrun:run@print-test-jdk-banner surefire:test failsafe:integration-test failsafe:verify jacoco:report@build-coverage-report-from-tests -Denforcer.skip=true
91105
92106
- name: Validate reference-impl-sync completeness
93107
if: >-
@@ -123,7 +137,7 @@ jobs:
123137
fi
124138
125139
- name: Upload test results for site generation
126-
if: success() && github.ref == 'refs/heads/main'
140+
if: success() && github.ref == 'refs/heads/main' && matrix.test-jdk == '25'
127141
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7
128142
with:
129143
name: test-results-for-site
@@ -134,11 +148,11 @@ jobs:
134148
retention-days: 1
135149

136150
- name: Generate JaCoCo badge
137-
if: success() && github.ref == 'refs/heads/main'
151+
if: success() && github.ref == 'refs/heads/main' && matrix.test-jdk == '25'
138152
run: .github/scripts/generate-coverage-badge.sh
139153

140154
- name: Create PR for JaCoCo badge update
141-
if: success() && github.ref == 'refs/heads/main'
155+
if: success() && github.ref == 'refs/heads/main' && matrix.test-jdk == '25'
142156
uses: peter-evans/create-pull-request@5f6978faf089d4d20b00c7766989d076bb2fc7f1 # v7
143157
with:
144158
commit-message: "Update JaCoCo coverage badge"
@@ -151,3 +165,16 @@ jobs:
151165
- name: Generate Test Report Summary
152166
if: always()
153167
uses: ./.github/actions/test-report
168+
with:
169+
title: "Copilot Java SDK :: Test Results JDK ${{ matrix.test-jdk }}"
170+
171+
- name: Upload test results on failure
172+
if: failure()
173+
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7
174+
with:
175+
name: test-results-jdk-${{ matrix.test-jdk }}
176+
path: |
177+
target/surefire-reports/
178+
target/surefire-reports-isolated/
179+
target/failsafe-reports/
180+
retention-days: 7

‎README.md‎

Lines changed: 31 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,14 @@
11
# GitHub Copilot SDK for Java
22

3-
[![Build](https://github.com/github/copilot-sdk-java/actions/workflows/build-test.yml/badge.svg)](https://github.com/github/copilot-sdk-java/actions/workflows/build-test.yml)
4-
[![Site](https://github.com/github/copilot-sdk-java/actions/workflows/deploy-site.yml/badge.svg)](https://github.com/github/copilot-sdk-java/actions/workflows/deploy-site.yml)
5-
[![Handwritten Coverage](.github/badges/jacoco-handwritten.svg)](https://github.github.io/copilot-sdk-java/snapshot/jacoco/index.html)
6-
[![Generated Coverage](.github/badges/jacoco-generated.svg)](https://github.github.io/copilot-sdk-java/snapshot/jacoco/index.html)
7-
[![Documentation](https://img.shields.io/badge/docs-online-brightgreen)](https://github.github.io/copilot-sdk-java/)
3+
[![Build](https://github.com/github/copilot-sdk/actions/workflows/java-sdk-tests.yml/badge.svg)](https://github.com/github/copilot-sdk/actions/workflows/java-sdk-tests.yml)
84
[![Java 17+](https://img.shields.io/badge/Java-17%2B-blue?logo=openjdk&logoColor=white)](https://openjdk.org/)
95
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
106

117
#### Latest release
12-
[![GitHub Release Date](https://img.shields.io/github/release-date/github/copilot-sdk-java)](https://github.com/github/copilot-sdk-java/releases)
13-
[![GitHub Release](https://img.shields.io/github/v/release/github/copilot-sdk-java)](https://github.com/github/copilot-sdk-java/releases)
8+
9+
[![GitHub Release Date](https://img.shields.io/github/release-date/github/copilot-sdk)](https://github.com/github/copilot-sdk/releases)
10+
[![GitHub Release](https://img.shields.io/github/v/release/github/copilot-sdk)](https://github.com/github/copilot-sdk/releases)
1411
[![Maven Central](https://img.shields.io/maven-central/v/com.github/copilot-sdk-java)](https://central.sonatype.com/artifact/com.github/copilot-sdk-java)
15-
[![Documentation](https://img.shields.io/badge/docs-latest-brightgreen)](https://github.github.io/copilot-sdk-java/latest/)
1612
[![Javadoc](https://javadoc.io/badge2/com.github/copilot-sdk-java/javadoc.svg?q=1)](https://javadoc.io/doc/com.github/copilot-sdk-java/latest/index.html)
1713

1814
## Background
@@ -23,21 +19,27 @@ Java SDK for programmatic control of GitHub Copilot CLI, enabling you to build A
2319

2420
## Installation
2521

26-
### Requirements
22+
### Runtime requirements
2723

28-
- Java 17 or later. **JDK 25 recommended**. Selecting JDK 25 enables the use of virtual threads, as shown in the [Quick Start](#quick-start).
29-
- GitHub Copilot CLI 1.0.17 or later installed and in `PATH` (or provide custom `cliPath`)
24+
- Java 17 or later. **JDK 25 recommended**. The distributed jar is a multi-release jar (MR-JAR) and is compiled on JDK 25 with `maven.compiler.release` set to 17. This means, when run on JDK 25 and later, the SDK automatically uses virtual threads for its default internal executor.
25+
- GitHub Copilot CLI 1.0.55-5. or later installed and in `PATH` (or provide custom `cliPath`)
3026

3127
### Maven
3228

3329
```xml
3430
<dependency>
3531
<groupId>com.github</groupId>
3632
<artifactId>copilot-sdk-java</artifactId>
37-
<version>1.0.0-beta-8-java.0</version>
33+
<version>1.0.0-beta-10-java.0</version>
3834
</dependency>
3935
```
4036

37+
### Gradle
38+
39+
```groovy
40+
implementation 'com.github:copilot-sdk-java:1.0.0-beta-10-java.0'
41+
42+
4143
#### Snapshot Builds
4244
4345
Snapshot builds of the next development version are published to Maven Central Snapshots. To use them, add the repository and update the dependency version in your `pom.xml`:
@@ -54,14 +56,14 @@ Snapshot builds of the next development version are published to Maven Central S
5456
<dependency>
5557
<groupId>com.github</groupId>
5658
<artifactId>copilot-sdk-java</artifactId>
57-
<version>1.0.0-beta-8-java.1-SNAPSHOT</version>
59+
<version>1.0.0-beta-10-java.0-SNAPSHOT</version>
5860
</dependency>
5961
```
6062

6163
### Gradle
6264

6365
```groovy
64-
implementation 'com.github:copilot-sdk-java:1.0.0-beta-8-java.0'
66+
implementation 'com.github:copilot-sdk-java:1.0.0-beta-10-java.0-SNAPSHOT'
6567
```
6668

6769
## Quick Start
@@ -70,23 +72,16 @@ implementation 'com.github:copilot-sdk-java:1.0.0-beta-8-java.0'
7072
import com.github.copilot.CopilotClient;
7173
import com.github.copilot.generated.AssistantMessageEvent;
7274
import com.github.copilot.generated.SessionUsageInfoEvent;
73-
import com.github.copilot.rpc.CopilotClientOptions;
7475
import com.github.copilot.rpc.MessageOptions;
7576
import com.github.copilot.rpc.PermissionHandler;
7677
import com.github.copilot.rpc.SessionConfig;
7778

78-
import java.util.concurrent.Executors;
79-
8079
public class CopilotSDK {
8180
public static void main(String[] args) throws Exception {
8281
var lastMessage = new String[]{null};
8382

8483
// Create and start client
85-
try (var client = new CopilotClient()) { // JDK 25+: comment out this line
86-
// JDK 25+: uncomment the following 3 lines for virtual thread support
87-
// var options = new CopilotClientOptions()
88-
// .setExecutor(Executors.newVirtualThreadPerTaskExecutor());
89-
// try (var client = new CopilotClient(options)) {
84+
try (var client = new CopilotClient()) {
9085
client.start().get();
9186

9287
// Create a session
@@ -130,31 +125,20 @@ See the full source of [`jbang-example.java`](jbang-example.java) for a complete
130125
Or run it directly from the repository:
131126

132127
```bash
133-
jbang https://github.com/github/copilot-sdk-java/blob/latest/jbang-example.java
128+
jbang https://github.com/github/copilot-sdk/blob/main/java/jbang-example.java
134129
```
135130

136-
## Documentation
137-
138-
📚 **[Full Documentation](https://github.github.io/copilot-sdk-java/)** — Complete API reference, advanced usage examples, and guides.
139-
140-
### Quick Links
141-
142-
- [Getting Started](https://github.github.io/copilot-sdk-java/latest/documentation.html)
143-
- [Javadoc API Reference](https://github.github.io/copilot-sdk-java/latest/apidocs/)
144-
- [MCP Servers Integration](https://github.github.io/copilot-sdk-java/latest/mcp.html)
145-
- [Cookbook](src/site/markdown/cookbook/) — Practical recipes for common use cases
146-
147131
## Projects Using This SDK
148132

149-
| Project | Description |
150-
|---------|-------------|
133+
| Project | Description |
134+
| ----------------------------------------------------------------------------- | ------------------------------------------ |
151135
| [JMeter Copilot Plugin](https://github.com/brunoborges/jmeter-copilot-plugin) | JMeter plugin for AI-assisted load testing |
152136

153137
> Want to add your project? Open a PR!
154138
155139
## CI/CD Workflows
156140

157-
This project uses several GitHub Actions workflows for building, testing, releasing, and syncing with the reference implementation SDK.
141+
This project uses several GitHub Actions workflows for building, testing, releasing, and syncing with the reference implementation SDK.
158142

159143
See [WORKFLOWS.md](docs/WORKFLOWS.md) for a full overview and details on each workflow.
160144

@@ -169,21 +153,28 @@ This SDK tracks the official [Copilot SDK](https://github.com/github/copilot-sdk
169153
**Automated sync** — A [scheduled GitHub Actions workflow](.github/workflows/reference-impl-sync.yml) runs on the schedule specified in that file. It checks for new reference implementation commits since the last merge (tracked in [`.lastmerge`](.lastmerge)), and if changes are found, creates an issue labeled `reference-impl-sync` and assigns it to the GitHub Copilot coding agent. Any previously open `reference-impl-sync` issues are automatically closed. The sync also updates the `@github/copilot` version in both `pom.xml` and `scripts/codegen/package.json` to keep schemas and test CLI in lockstep.
170154

171155
**Reusable prompt** — The merge workflow is defined in [`agentic-merge-reference-impl.prompt.md`](.github/prompts/agentic-merge-reference-impl.prompt.md). It can be triggered manually from:
156+
172157
- **VS Code Copilot Chat** — type `/agentic-merge-reference-impl`
173158
- **GitHub Copilot CLI** — use `copilot` CLI with the same skill reference
174159

175160
### Development Setup
176161

162+
Requires JDK 25 or later for development.
163+
177164
```bash
178165
# Clone the repository
179-
git clone https://github.com/github/copilot-sdk-java.git
180-
cd copilot-sdk-java
166+
git clone https://github.com/github/copilot-sdk.git
167+
cd copilot-sdk/java
181168

182169
# Enable git hooks for code formatting
183170
git config core.hooksPath .githooks
184171

185-
# Build and test
172+
# Build and test with JDK 25
186173
mvn clean verify
174+
175+
# Set your paths for JDK 17
176+
# Run the JDK 25 built jar with JDK 17 JVM for tests. Do not re-compile the jar.
177+
mvn jacoco:prepare-agent@wire-up-coverage-instrumentation antrun:run@print-test-jdk-banner surefire:test failsafe:integration-test failsafe:verify jacoco:report@build-coverage-report-from-tests -Denforcer.skip=true
187178
```
188179

189180
The tests require the official [copilot-sdk](https://github.com/github/copilot-sdk) test harness, which is automatically cloned during build.
@@ -204,12 +195,3 @@ See [SECURITY.md](SECURITY.md) for reporting security vulnerabilities.
204195

205196
MIT — see [LICENSE](LICENSE) for details.
206197

207-
## Acknowledgement
208-
209-
- Initially developed with Copilot and [Bruno Borges](https://www.linkedin.com/in/brunocborges/).
210-
211-
## Star History
212-
213-
[![Star History Chart](https://api.star-history.com/svg?repos=github/copilot-sdk-java&type=Date)](https://www.star-history.com/#github/copilot-sdk-java&Date)
214-
215-
⭐ Drop a star if you find this useful!

‎jbang-example.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
///usr/bin/env jbang "$0" "$@" ; exit $?
2-
//DEPS com.github:copilot-sdk-java:1.0.0-beta-8-java.0
2+
//DEPS com.github:copilot-sdk-java:1.0.0-beta-java.4
33
import com.github.copilot.CopilotClient;
44
import com.github.copilot.generated.AssistantMessageEvent;
55
import com.github.copilot.generated.SessionUsageInfoEvent;

0 commit comments

Comments
 (0)