Add documentation site generation for Java SDK#1524
Merged
Conversation
… SDK Port src/site/ from the standalone repo (copilot-sdk-java) to the monorepo's java/ directory. Add maven-resources-plugin executions for site filtering, maven-site-plugin configuration with doxia-module-markdown, and a full <reporting> section (javadoc, JaCoCo, surefire, SpotBugs, taglist, dependency analysis). Add a deploy-site job to java-publish-maven.yml that triggers the standalone repo's deploy-site.yml workflow after a release, passing version and monorepo tag information. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds Maven Site generation infrastructure for the Java SDK documentation (ported from the standalone repo) and wires release automation to trigger a documentation deployment workflow in github/copilot-sdk-java.
Changes:
- Adds a full Maven Site source tree under
java/src/site/(site descriptor, markdown docs, CSS/theme assets, JaCoCo CSS overlay). - Updates
java/pom.xmlto generate a filtered site and configure site/reporting plugins (Javadoc, JaCoCo, Surefire report, SpotBugs, etc.). - Extends the Java publish workflow to trigger cross-repo site deployment after a release on
main.
Show a summary per file
| File | Description |
|---|---|
| java/src/site/site.xml | Maven Site descriptor (menus, Fluido skin config). |
| java/src/site/resources/css/site.css | Custom site theme layered on Fluido skin. |
| java/src/site/markdown/index.md | Site landing page with requirements, install, and quick example. |
| java/src/site/markdown/getting-started.md | Step-by-step tutorial for first app, streaming, and tools. |
| java/src/site/markdown/setup.md | Deployment/ops guidance (local CLI, OAuth, external server, BYOK). |
| java/src/site/markdown/documentation.md | Core SDK usage guide (events, streaming, session management, etc.). |
| java/src/site/markdown/advanced.md | Advanced feature guide (tools, BYOK, hooks, telemetry, elicitation, etc.). |
| java/src/site/markdown/mcp.md | Guide for MCP server configuration and troubleshooting. |
| java/src/site/markdown/hooks.md | Detailed session hooks documentation and examples. |
| java/src/site/markdown/cookbook/README.md | Cookbook index and recipe links. |
| java/src/site/markdown/cookbook/error-handling.md | Cookbook recipe covering error-handling patterns. |
| java/src/site/markdown/cookbook/multiple-sessions.md | Cookbook recipe for parallel sessions and executor usage. |
| java/src/site/markdown/cookbook/managing-local-files.md | Cookbook recipe for file organization workflows. |
| java/src/site/markdown/cookbook/persisting-sessions.md | Cookbook recipe for session persistence/resume/delete patterns. |
| java/src/site/markdown/cookbook/pr-visualization.md | Cookbook recipe for generating PR-age charts using GitHub MCP server. |
| java/src/site/jacoco-resources/report.css | Custom JaCoCo report stylesheet overlay to match site theme. |
| java/pom.xml | Adds site filtering, site plugin config, and reporting section for site generation. |
| .github/workflows/java-publish-maven.yml | Adds a deploy-site job to trigger cross-repo documentation deployment post-release. |
Copilot's findings
- Files reviewed: 18/20 changed files
- Comments generated: 3
Site content (src/site/) and reporting plugins now live in github/copilot-sdk-java where the gh-pages deployment runs. The monorepo only triggers the standalone's deploy-site workflow and provides the Java source at the release tag. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
- Remove deploy-site job from java-publish-maven.yml (will be re-added after validation) - Add PR-1524-test-java-publish-maven.yml with hardcoded tag java/v1.0.0-beta-10-java.5 for testing the cross-repo trigger Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Ports Maven Site infrastructure from the standalone repo and adds a deploy-site job to java-publish-maven.yml that triggers site deployment on github/copilot-sdk-java's gh-pages branch.
Changes
<reporting>section (javadoc, JaCoCo, surefire, SpotBugs, taglist, dependency analysis)deploy-sitejob that triggers deploy-site.yml on the standalone repo after releaseSecrets required
JAVA_SITE_DEPLOY_TOKENon this repo: PAT withactions:writeon github/copilot-sdk-java to trigger workflow_dispatchCompanion PR
github/copilot-sdk-java — cross-repo deploy-site.yml rewrite (to be opened)