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

Copilot · brunoborges · Copilot · commit c9cb5511dbc7 · 2026-02-14T22:38:54.000Z
Co-authored-by: brunoborges &lt;129743+brunoborges@users.noreply.github.com&gt;
diff --git a/.github/workflows/publish-maven.yml b/.github/workflows/publish-maven.yml
@@ -116,8 +116,13 @@ jobs:
                   # Update version in jbang-example.java
                   sed -i "s|copilot-sdk:[0-9]*\.[0-9]*\.[0-9]*|copilot-sdk:${VERSION}|g" jbang-example.java
                   
+                  # Update version in cookbook files (Maven will filter ${project.version} during site generation,
+                  # but we also need the actual version for direct JBang usage)
+                  find src/site/markdown/cookbook -name "*.md" -type f -exec \
+                    sed -i "s|\${project.version}|${VERSION}|g" {} \;
+                  
                   # Commit the documentation changes before release:prepare (requires clean working directory)
-                  git add CHANGELOG.md README.md jbang-example.java
+                  git add CHANGELOG.md README.md jbang-example.java src/site/markdown/cookbook/
                   git commit -m "docs: update version references to ${VERSION}"
                   
                   # Save the commit SHA for potential rollback
diff --git a/README.md b/README.md
@@ -105,7 +105,7 @@ jbang https://github.com/copilot-community-sdk/copilot-sdk-java/blob/latest/jban
 - [Getting Started](https://copilot-community-sdk.github.io/copilot-sdk-java/documentation.html)
 - [Javadoc API Reference](https://copilot-community-sdk.github.io/copilot-sdk-java/apidocs/)
 - [MCP Servers Integration](https://copilot-community-sdk.github.io/copilot-sdk-java/mcp.html)
-- [Cookbook](cookbook/) — Practical recipes for common use cases
+- [Cookbook](https://copilot-community-sdk.github.io/copilot-sdk-java/cookbook/) — Practical recipes for common use cases
 
 ## Projects Using This SDK
 
diff --git a/src/site/markdown/cookbook/README.md b/src/site/markdown/cookbook/README.md
diff --git a/src/site/markdown/cookbook/error-handling.md b/src/site/markdown/cookbook/error-handling.md
@@ -9,6 +9,7 @@ You need to handle various error conditions like connection failures, timeouts,
 ## Basic error handling
 
 ```java
+//DEPS io.github.copilot-community-sdk:copilot-sdk:${project.version}
 import com.github.copilot.sdk.*;
 import com.github.copilot.sdk.events.*;
 import com.github.copilot.sdk.json.*;
@@ -40,6 +41,10 @@ public class BasicErrorHandling {
 ## Handling specific error types
 
 ```java
+//DEPS io.github.copilot-community-sdk:copilot-sdk:${project.version}
+import com.github.copilot.sdk.*;
+import com.github.copilot.sdk.events.*;
+import com.github.copilot.sdk.json.*;
 import java.io.IOException;
 import java.util.concurrent.ExecutionException;
 import java.util.concurrent.TimeoutException;
@@ -69,6 +74,10 @@ public class SpecificErrorHandling {
 ## Timeout handling
 
 ```java
+//DEPS io.github.copilot-community-sdk:copilot-sdk:${project.version}
+import com.github.copilot.sdk.*;
+import com.github.copilot.sdk.events.*;
+import com.github.copilot.sdk.json.*;
 import java.util.concurrent.TimeUnit;
 import java.util.concurrent.TimeoutException;
 
@@ -96,6 +105,10 @@ public class TimeoutHandling {
 ## Aborting a request
 
 ```java
+//DEPS io.github.copilot-community-sdk:copilot-sdk:${project.version}
+import com.github.copilot.sdk.*;
+import com.github.copilot.sdk.events.*;
+import com.github.copilot.sdk.json.*;
 import java.util.concurrent.Executors;
 import java.util.concurrent.ScheduledExecutorService;
 import java.util.concurrent.TimeUnit;
@@ -123,6 +136,11 @@ public class AbortRequest {
 ## Graceful shutdown
 
 ```java
+//DEPS io.github.copilot-community-sdk:copilot-sdk:${project.version}
+import com.github.copilot.sdk.*;
+import com.github.copilot.sdk.events.*;
+import com.github.copilot.sdk.json.*;
+
 public class GracefulShutdown {
     public static void main(String[] args) {
         var client = new CopilotClient();
@@ -150,6 +168,11 @@ public class GracefulShutdown {
 ## Try-with-resources pattern
 
 ```java
+//DEPS io.github.copilot-community-sdk:copilot-sdk:${project.version}
+import com.github.copilot.sdk.*;
+import com.github.copilot.sdk.events.*;
+import com.github.copilot.sdk.json.*;
+
 public class TryWithResources {
     public static void doWork() throws Exception {
         try (var client = new CopilotClient()) {
@@ -175,6 +198,10 @@ public class TryWithResources {
 ## Handling tool errors
 
 ```java
+//DEPS io.github.copilot-community-sdk:copilot-sdk:${project.version}
+import com.github.copilot.sdk.*;
+import com.github.copilot.sdk.events.*;
+import com.github.copilot.sdk.json.*;
 import java.util.Map;
 import java.util.List;
 import java.util.concurrent.CompletableFuture;
diff --git a/src/site/markdown/cookbook/managing-local-files.md b/src/site/markdown/cookbook/managing-local-files.md
@@ -9,6 +9,7 @@ You have a folder with many files and want to organize them into subfolders base
 ## Example code
 
 ```java
+//DEPS io.github.copilot-community-sdk:copilot-sdk:${project.version}
 import com.github.copilot.sdk.*;
 import com.github.copilot.sdk.events.*;
 import com.github.copilot.sdk.json.*;
@@ -130,6 +131,7 @@ session.send(new MessageOptions().setPrompt(prompt));
 ## Interactive file organization
 
 ```java
+//DEPS io.github.copilot-community-sdk:copilot-sdk:${project.version}
 import java.io.BufferedReader;
 import java.io.InputStreamReader;
 
diff --git a/src/site/markdown/cookbook/multiple-sessions.md b/src/site/markdown/cookbook/multiple-sessions.md
@@ -9,6 +9,7 @@ You need to run multiple conversations in parallel, each with its own context an
 ## Java
 
 ```java
+//DEPS io.github.copilot-community-sdk:copilot-sdk:${project.version}
 import com.github.copilot.sdk.*;
 import com.github.copilot.sdk.events.*;
 import com.github.copilot.sdk.json.*;
@@ -99,6 +100,7 @@ try {
 ## Managing session lifecycle with CompletableFuture
 
 ```java
+//DEPS io.github.copilot-community-sdk:copilot-sdk:${project.version}
 import java.util.concurrent.CompletableFuture;
 import java.util.List;
 
diff --git a/src/site/markdown/cookbook/persisting-sessions.md b/src/site/markdown/cookbook/persisting-sessions.md
@@ -9,6 +9,7 @@ You want users to be able to continue a conversation even after closing and reop
 ## Creating a session with a custom ID
 
 ```java
+//DEPS io.github.copilot-community-sdk:copilot-sdk:${project.version}
 import com.github.copilot.sdk.*;
 import com.github.copilot.sdk.events.*;
 import com.github.copilot.sdk.json.*;
@@ -127,6 +128,7 @@ public class SessionHistory {
 ## Complete example with session management
 
 ```java
+//DEPS io.github.copilot-community-sdk:copilot-sdk:${project.version}
 import java.util.Scanner;
 
 public class SessionManager {
diff --git a/src/site/markdown/cookbook/pr-visualization.md b/src/site/markdown/cookbook/pr-visualization.md
@@ -31,6 +31,7 @@ java PRVisualization.java github/copilot-sdk
 ## Full example: PRVisualization.java
 
 ```java
+//DEPS io.github.copilot-community-sdk:copilot-sdk:${project.version}
 import com.github.copilot.sdk.*;
 import com.github.copilot.sdk.events.*;
 import com.github.copilot.sdk.json.*;
diff --git a/src/site/site.xml b/src/site/site.xml
@@ -62,6 +62,15 @@
             <item name="Session Hooks" href="hooks.html"/>
         </menu>
 
+        <menu name="Cookbook">
+            <item name="Overview" href="cookbook/README.html"/>
+            <item name="Error Handling" href="cookbook/error-handling.html"/>
+            <item name="Multiple Sessions" href="cookbook/multiple-sessions.html"/>
+            <item name="Managing Local Files" href="cookbook/managing-local-files.html"/>
+            <item name="PR Visualization" href="cookbook/pr-visualization.html"/>
+            <item name="Persisting Sessions" href="cookbook/persisting-sessions.html"/>
+        </menu>
+
         <menu ref="reports"/>
 
     </body>
