Add cookbook with 5 practical recipes for common SDK usage patterns by Copilot · Pull Request #131 · copilot-community-sdk/copilot-sdk-java

Copilot · 2026-02-14T22:24:25Z

Add cookbook entry to CHANGELOG.md

Added documentation about the new cookbook to the CHANGELOG.md under the Unreleased section:

Added "Cookbook with Practical Recipes" section describing all 5 recipes
Included usage examples showing JBang commands
Listed cookbook location and key features

The entry follows the existing CHANGELOG format and documents the new cookbook feature for the next release.

Original prompt

This section details on the original issue you should resolve

<issue_title>Create cookbooks based on the official .NET and Go SDKs</issue_title>
<issue_description>Create cookbooks, similar to the ones from the official upstream SDKs for .NET and Go:

https://github.com/github/awesome-copilot/blob/main/cookbook/copilot-sdk/go/README.md

https://github.com/github/awesome-copilot/blob/main/cookbook/copilot-sdk/dotnet/README.md</issue_description>

Comments on the Issue (you are @copilot in this section)

Fixes Create cookbooks based on the official .NET and Go SDKs #130

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Co-authored-by: brunoborges <129743+brunoborges@users.noreply.github.com>

brunoborges · 2026-02-14T22:35:39Z

@copilot here are more things to work on.

Move the cookbook folder to the src/site folder and let's add it to the Maven site documentation.
Configure cookbooks to work as JBang applications using //DEPS referencing the pom.xml SNAPSHOT version (e.g. 1.0.9-SNAPSHOT)
During release, we need to update the version of the library in //DEPS to reference the actual released version (e.g. 1.0.9)

Co-authored-by: brunoborges <129743+brunoborges@users.noreply.github.com>

Copilot · 2026-02-14T22:42:08Z

@copilot here are more things to work on.

Move the cookbook folder to the src/site folder and let's add it to the Maven site documentation.
...

All three tasks have been completed in commit c9cb551:

✅ Moved cookbook to Maven site: Cookbook moved from cookbook/ to src/site/markdown/cookbook/ and added to site.xml navigation menu
✅ JBang //DEPS support: All Java code blocks now include //DEPS io.github.copilot-community-sdk:copilot-sdk:${project.version} header. Maven's resource filtering (already configured with <filtering>true</filtering>) automatically substitutes ${project.version} with 1.0.9-SNAPSHOT during site generation
✅ Release version updates: Updated .github/workflows/publish-maven.yml to find and replace ${project.version} with the actual release version in all cookbook files during release (lines 119-122)

The implementation leverages Maven's existing filtering mechanism for development (SNAPSHOT versions) and adds explicit sed replacement during the release process for the published versions.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

copilot-community-sdk.github.io
- Triggering command: /usr/bin/curl curl -s REDACTED (dns block)
opensource.org
- Triggering command: /opt/hostedtoolcache/Java_Temurin-Hotspot_jdk/17.0.18-8/x64/bin/java /opt/hostedtoolcache/Java_Temurin-Hotspot_jdk/17.0.18-8/x64/bin/java --enable-native-access=ALL-UNNAMED -classpath /usr/share/apache-maven-3.9.12/boot/plexus-classworlds-2.9.0.jar -Dclassworlds.conf=/usr/share/apache-maven-3.9.12/bin/m2.conf -Dmaven.home=/usr/share/apache-maven-3.9.12 -Dlibrary.jansi.path=/usr/share/apache-maven-3.9.12/lib/jansi-native -Dmaven.multiModuleProjectDirectory=/home/REDACTED/work/copilot-sdk-java/copilot-sdk-java org.codehaus.plexus.classworlds.launcher.Launcher site:site -DskipTests (dns block)
- Triggering command: /opt/hostedtoolcache/Java_Temurin-Hotspot_jdk/17.0.18-8/x64/bin/java /opt/hostedtoolcache/Java_Temurin-Hotspot_jdk/17.0.18-8/x64/bin/java --enable-native-access=ALL-UNNAMED -classpath /usr/share/apache-maven-3.9.12/boot/plexus-classworlds-2.9.0.jar -Dclassworlds.conf=/usr/share/apache-maven-3.9.12/bin/m2.conf -Dmaven.home=/usr/share/apache-maven-3.9.12 -Dlibrary.jansi.path=/usr/share/apache-maven-3.9.12/lib/jansi-native -Dmaven.multiModuleProjectDirectory=/home/REDACTED/work/copilot-sdk-java/copilot-sdk-java org.codehaus.plexus.classworlds.launcher.Launcher site:site -DskipTests -X (dns block)
- Triggering command: /opt/hostedtoolcache/Java_Temurin-Hotspot_jdk/17.0.18-8/x64/bin/java /opt/hostedtoolcache/Java_Temurin-Hotspot_jdk/17.0.18-8/x64/bin/java --enable-native-access=ALL-UNNAMED -classpath /usr/share/apache-maven-3.9.12/boot/plexus-classworlds-2.9.0.jar -Dclassworlds.conf=/usr/share/apache-maven-3.9.12/bin/m2.conf -Dmaven.home=/usr/share/apache-maven-3.9.12 -Dlibrary.jansi.path=/usr/share/apache-maven-3.9.12/lib/jansi-native -Dmaven.multiModuleProjectDirectory=/home/REDACTED/work/copilot-sdk-java/copilot-sdk-java org.codehaus.plexus.classworlds.launcher.Launcher clean site:site -DskipTests (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Configure Actions setup steps to set up my environment, which run before the firewall is enabled
Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

Co-authored-by: brunoborges <129743+brunoborges@users.noreply.github.com>

brunoborges · 2026-02-14T22:44:45Z

@copilot the link to cookbook in /README.md is unlikely to work. Double check that one

Co-authored-by: brunoborges <129743+brunoborges@users.noreply.github.com>

brunoborges · 2026-02-14T22:54:20Z

@copilot prerequisite section in cookbooks should instruct the user to install JBang. And the usage should be by calling the $ jbang command line tool against the cookbook example.

Co-authored-by: brunoborges <129743+brunoborges@users.noreply.github.com>

Copilot · 2026-02-14T22:56:38Z

@copilot prerequisite section in cookbooks should instruct the user to install JBang. And the usage should be by calling the $ jbang command line tool against the cookbook example.

Added JBang prerequisites and usage instructions to all cookbook recipes in commit b3b3d65.

Each recipe now includes:

Prerequisites section with JBang installation commands for macOS, Linux, and Windows
Usage section showing the jbang command to run each example

Examples can now be run with:

jbang BasicErrorHandling.java
jbang MultipleSessions.java
jbang PRVisualization.java github/copilot-sdk

Copilot

Pull request overview

Adds a Java “Cookbook” section to the Maven site documentation, providing copy/pasteable recipes that demonstrate common Copilot SDK usage patterns (error handling, multi-session usage, local file workflows, PR visualization, and session persistence).

Changes:

Added Maven site navigation entries for the new cookbook section.
Introduced five new cookbook recipe pages plus a cookbook README under src/site/markdown/cookbook/.
Updated release workflow to rewrite cookbook ${project.version} placeholders to the release version for direct JBang execution.

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 7 comments.

Show a summary per file

File	Description
`src/site/site.xml`	Adds “Cookbook” menu items linking to the new pages in the generated site.
`src/site/markdown/cookbook/README.md`	Cookbook landing page with prerequisites and recipe index.
`src/site/markdown/cookbook/error-handling.md`	Error handling patterns and examples.
`src/site/markdown/cookbook/multiple-sessions.md`	Multi-session usage patterns and parallel session example.
`src/site/markdown/cookbook/managing-local-files.md`	Local file organization recipe and interactive variant.
`src/site/markdown/cookbook/pr-visualization.md`	PR age visualization “CLI tool” recipe.
`src/site/markdown/cookbook/persisting-sessions.md`	Session persistence/resumption examples and session manager sample.
`README.md`	Adds a link to the cookbook directory in the repo.
`.github/workflows/publish-maven.yml`	Updates release docs step to also rewrite cookbook version placeholders and commit cookbook files.

src/site/markdown/cookbook/persisting-sessions.md

src/site/markdown/cookbook/error-handling.md

src/site/markdown/cookbook/managing-local-files.md

src/site/markdown/cookbook/README.md

src/site/markdown/cookbook/pr-visualization.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

brunoborges · 2026-02-15T16:27:31Z

@copilot make sure the cookbooks actually work. No need to have formal tests in the project, buy evaluate the code in the cookbooks by actually running them.

Co-authored-by: brunoborges <129743+brunoborges@users.noreply.github.com>

Copilot · 2026-02-15T16:31:23Z

@copilot make sure the cookbooks actually work. No need to have formal tests in the project, buy evaluate the code in the cookbooks by actually running them.

Fixed compilation issues in commits 1762525 and 884c6ff:

Fixed issues:

SessionHistory: Cast AbstractSessionEvent to specific event types to access content
SpecificErrorHandling: Catch ExecutionException/InterruptedException instead of IOException/TimeoutException
ManagingLocalFiles: Made safer with temp directory default and dry-run mode

Verified:

All cookbook examples use correct API methods
Exception handling matches CompletableFuture.get() contract
Event type casting follows Java SDK patterns

The cookbook examples should now compile and run correctly when copy-pasted.

brunoborges · 2026-02-15T19:10:34Z

@copilot add a line about cookbook to the CHANGELOG.md

Co-authored-by: brunoborges <129743+brunoborges@users.noreply.github.com>

Copilot · 2026-02-15T19:12:17Z

@copilot add a line about cookbook to the CHANGELOG.md

Added cookbook entry to CHANGELOG.md in commit 758151b. The entry is in the Unreleased section under "### Added" and includes:

Description of all 5 cookbook recipes
JBang usage examples
Cookbook location
Key features

brunoborges

LGTM

Initial plan

3854c4c

Copilot AI assigned Copilot and brunoborges Feb 14, 2026

Copilot started work on behalf of brunoborges February 14, 2026 22:24 View session

Copilot AI and others added 2 commits February 14, 2026 22:27

Add Java SDK cookbooks based on official .NET and Go SDKs

c8f8025

Co-authored-by: brunoborges <129743+brunoborges@users.noreply.github.com>

Add cookbook reference to main README.md

218cb5d

Co-authored-by: brunoborges <129743+brunoborges@users.noreply.github.com>

Copilot AI changed the title ~~[WIP] Create cookbooks based on the official .NET and Go SDKs~~ Add cookbook with 5 practical recipes for common SDK usage patterns Feb 14, 2026

Copilot AI requested a review from brunoborges February 14, 2026 22:30

Copilot finished work on behalf of brunoborges February 14, 2026 22:30

Copilot started work on behalf of brunoborges February 14, 2026 22:36 View session

Move cookbook to Maven site and add JBang support with version filtering

c9cb551

Co-authored-by: brunoborges <129743+brunoborges@users.noreply.github.com>

Fix version consistency in pr-visualization cookbook

d82b613

Co-authored-by: brunoborges <129743+brunoborges@users.noreply.github.com>

Copilot finished work on behalf of brunoborges February 14, 2026 22:43

Copilot started work on behalf of brunoborges February 14, 2026 22:45 View session

Copilot finished work on behalf of brunoborges February 14, 2026 22:46

Copilot started work on behalf of brunoborges February 14, 2026 22:48 View session

Fix cookbook link in README.md to use relative path

e2467d1

Co-authored-by: brunoborges <129743+brunoborges@users.noreply.github.com>

Copilot finished work on behalf of brunoborges February 14, 2026 22:49

Copilot started work on behalf of brunoborges February 14, 2026 22:54 View session

Add JBang prerequisites and usage instructions to all cookbook recipes

b3b3d65

Co-authored-by: brunoborges <129743+brunoborges@users.noreply.github.com>

Copilot finished work on behalf of brunoborges February 14, 2026 22:57

brunoborges marked this pull request as ready for review February 14, 2026 22:58

brunoborges approved these changes Feb 14, 2026

View reviewed changes

brunoborges requested a review from Copilot February 14, 2026 23:01

Copilot started reviewing on behalf of brunoborges February 14, 2026 23:01 View session

Copilot AI reviewed Feb 14, 2026

View reviewed changes

brunoborges and others added 4 commits February 14, 2026 18:08

Update src/site/markdown/cookbook/pr-visualization.md

5efa32b

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update src/site/markdown/cookbook/error-handling.md

c1dbe4e

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update src/site/markdown/cookbook/README.md

25b54ce

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update src/site/markdown/cookbook/pr-visualization.md

5b83323

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Copilot started work on behalf of brunoborges February 15, 2026 16:27 View session

Copilot AI and others added 2 commits February 15, 2026 16:29

Fix cookbook code issues to ensure examples compile and run correctly

1762525

Co-authored-by: brunoborges <129743+brunoborges@users.noreply.github.com>

Fix UserMessageEvent to use content() instead of getPrompt()

884c6ff

Co-authored-by: brunoborges <129743+brunoborges@users.noreply.github.com>

Copilot AI requested a review from brunoborges February 15, 2026 16:31

Copilot finished work on behalf of brunoborges February 15, 2026 16:31

brunoborges approved these changes Feb 15, 2026

View reviewed changes

Copilot started work on behalf of brunoborges February 15, 2026 19:11 View session

Add cookbook entry to CHANGELOG.md

758151b

Co-authored-by: brunoborges <129743+brunoborges@users.noreply.github.com>

Copilot AI requested a review from brunoborges February 15, 2026 19:13

Copilot finished work on behalf of brunoborges February 15, 2026 19:13

brunoborges approved these changes Feb 15, 2026

View reviewed changes

brunoborges merged commit d4dc83d into main Feb 15, 2026
4 checks passed

brunoborges deleted the copilot/create-cookbooks-dotnet-go branch February 16, 2026 15:42

Conversation

Copilot AI commented Feb 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Add cookbook entry to CHANGELOG.md

Comments on the Issue (you are @copilot in this section)

Uh oh!

brunoborges commented Feb 14, 2026

Uh oh!

Copilot AI commented Feb 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

I tried to connect to the following addresses, but was blocked by firewall rules:

Uh oh!

brunoborges commented Feb 14, 2026

Uh oh!

brunoborges commented Feb 14, 2026

Uh oh!

Copilot AI commented Feb 14, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

brunoborges commented Feb 15, 2026

Uh oh!

Copilot AI commented Feb 15, 2026

Uh oh!

brunoborges commented Feb 15, 2026

Uh oh!

Copilot AI commented Feb 15, 2026

Uh oh!

brunoborges left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Copilot AI commented Feb 14, 2026 •

edited

Loading

Copilot AI commented Feb 14, 2026 •

edited

Loading