Skip to content

Cross-repo documentation deployment from monorepo #242

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
edburns merged 3 commits into from
Jun 1, 2026
Merged

Cross-repo documentation deployment from monorepo #242

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8d3b2d0
Rewrite deploy-site.yml for cross-repo builds from monorepo
edburns Jun 1, 2026
73c8d09
Move site content and POM to standalone repo for cross-repo site builds
edburns Jun 1, 2026
534affb
Fix deploy-site.yml: validate inputs/secrets, use DEPLOY_VERSION in c…
Copilot Jun 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/templates/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<h1>GitHub Copilot SDK for <span class="gradient-text">Java</span></h1>
<p class="hero-subtitle">The official SDK for building AI-powered tools with GitHub Copilot's agentic runtime.</p>
<div class="header-buttons">
<a href="https://github.com/github/copilot-sdk-java" class="btn btn-github">
<a href="https://github.com/github/copilot-sdk/tree/main/java" class="btn btn-github">
<svg height="20" width="20" viewBox="0 0 16 16"><path d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0016 8c0-4.42-3.58-8-8-8z"></path></svg>
View on GitHub
</a>
Expand Down Expand Up @@ -75,7 +75,7 @@ <h2 class="section-title">Available Versions</h2>

<footer class="footer">
<div class="footer-links">
<a href="https://github.com/github/copilot-sdk-java">GitHub Repository</a>
<a href="https://github.com/github/copilot-sdk/tree/main/java">GitHub Repository</a>
<span class="sep">·</span>
<a href="https://central.sonatype.com/artifact/com.github/copilot-sdk">Maven Central</a>
<span class="sep">·</span>
Expand Down
304 changes: 105 additions & 199 deletions .github/workflows/deploy-site.yml
View file
Open in desktop

Large diffs are not rendered by default.

261 changes: 261 additions & 0 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,261 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Site-only POM for github/copilot-sdk-java.
This POM builds the Maven Site (javadoc, JaCoCo, SpotBugs, etc.) from
Java source code checked out from the monorepo (github/copilot-sdk) at
a release tag. It is NOT used for compiling/testing the SDK itself.

Expected layout at build time (set up by deploy-site.yml):
. (this repo — standalone)
├── pom.xml (this file)
├── src/site/ (site content: markdown, site.xml, CSS)
└── monorepo/ (checkout of github/copilot-sdk at release tag)
└── java/
└── src/main/java/ (SDK source for javadoc)
└── target/ (compiled classes from monorepo build)
-->
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>

<groupId>com.github</groupId>
<artifactId>copilot-sdk-java-site</artifactId>
<version>${site.version}</version>
<packaging>pom</packaging>

<name>GitHub Copilot SDK for Java — Documentation Site</name>
<description>Maven Site build for the GitHub Copilot SDK for Java</description>
<url>https://github.com/github/copilot-sdk-java</url>

<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<!-- Overridden at build time via -Dsite.version=... -->
<site.version>0.0.0-SNAPSHOT</site.version>
<!-- Path to the monorepo checkout (relative to this POM) -->
<monorepo.java.dir>${project.basedir}/monorepo/java</monorepo.java.dir>
</properties>

<!-- Dependencies needed on classpath for javadoc link resolution -->
<dependencies>
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
<version>2.21.3</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-annotations</artifactId>
<version>2.21</version>
<scope>provided</scope>
</dependency>
</dependencies>

<build>
<!-- Point source directory at monorepo's Java source for reports -->
<sourceDirectory>${monorepo.java.dir}/src/main/java</sourceDirectory>

<plugins>
<!-- Maven Resources Plugin — site-filtering executions -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-resources-plugin</artifactId>
<version>3.5.0</version>
<executions>
<execution>
<id>filter-site-markdown</id>
<phase>pre-site</phase>
<goals>
<goal>copy-resources</goal>
</goals>
<configuration>
<outputDirectory>${project.build.directory}/filtered-site/markdown</outputDirectory>
<resources>
<resource>
<directory>src/site/markdown</directory>
<filtering>true</filtering>
</resource>
</resources>
</configuration>
</execution>
<execution>
<id>copy-site-descriptor</id>
<phase>pre-site</phase>
<goals>
<goal>copy-resources</goal>
</goals>
<configuration>
<outputDirectory>${project.build.directory}/filtered-site</outputDirectory>
<resources>
<resource>
<directory>src/site</directory>
<includes>
<include>site.xml</include>
</includes>
<filtering>false</filtering>
</resource>
</resources>
</configuration>
</execution>
<execution>
<id>copy-site-resources</id>
<phase>pre-site</phase>
<goals>
<goal>copy-resources</goal>
</goals>
<configuration>
<outputDirectory>${project.build.directory}/filtered-site/resources</outputDirectory>
<resources>
<resource>
<directory>src/site/resources</directory>
<filtering>false</filtering>
</resource>
</resources>
</configuration>
</execution>
<execution>
<id>overlay-jacoco-css</id>
<phase>site</phase>
<goals>
<goal>copy-resources</goal>
</goals>
<configuration>
<outputDirectory>${project.reporting.outputDirectory}/jacoco/jacoco-resources</outputDirectory>
<resources>
<resource>
<directory>src/site/jacoco-resources</directory>
<filtering>false</filtering>
</resource>
</resources>
<overwrite>true</overwrite>
</configuration>
</execution>
</executions>
</plugin>
<!-- Maven Site Plugin -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-site-plugin</artifactId>
<version>3.21.0</version>
<configuration>
<inputEncoding>UTF-8</inputEncoding>
<outputEncoding>UTF-8</outputEncoding>
<siteDirectory>${project.build.directory}/filtered-site</siteDirectory>
<generatedSiteDirectory>${project.build.directory}/filtered-site-generated</generatedSiteDirectory>
</configuration>
<dependencies>
<dependency>
<groupId>org.apache.maven.doxia</groupId>
<artifactId>doxia-module-markdown</artifactId>
<version>2.1.0</version>
</dependency>
</dependencies>
</plugin>
</plugins>
</build>

<!-- Reporting plugins for Maven Site -->
<reporting>
<plugins>
<!-- Project Info Reports -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-project-info-reports-plugin</artifactId>
<version>3.9.0</version>
</plugin>
<!-- Javadoc from monorepo source -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.11.2</version>
<configuration>
<sourcepath>${monorepo.java.dir}/src/main/java</sourcepath>
<subpackages>com.github.copilot</subpackages>
</configuration>
<reportSets>
<reportSet>
<reports>
<report>javadoc</report>
</reports>
</reportSet>
</reportSets>
</plugin>
<!-- JaCoCo coverage (from monorepo test run) -->
<plugin>
<groupId>org.jacoco</groupId>
<artifactId>jacoco-maven-plugin</artifactId>
<version>0.8.14</version>
<configuration>
<dataFile>${monorepo.java.dir}/target/jacoco-test-results/sdk-tests.exec</dataFile>
</configuration>
<reportSets>
<reportSet>
<reports>
<report>report</report>
</reports>
</reportSet>
</reportSets>
</plugin>
<!-- Surefire test results report -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-report-plugin</artifactId>
<version>3.5.5</version>
<configuration>
<reportsDirectories>
<reportsDirectory>${monorepo.java.dir}/target/surefire-reports</reportsDirectory>
</reportsDirectories>
</configuration>
</plugin>
<!-- SpotBugs static analysis -->
<plugin>
<groupId>com.github.spotbugs</groupId>
<artifactId>spotbugs-maven-plugin</artifactId>
<version>4.9.8.3</version>
<configuration>
<excludeFilterFile>${monorepo.java.dir}/config/spotbugs/spotbugs-exclude.xml</excludeFilterFile>
</configuration>
</plugin>
<!-- TODO/FIXME tag tracker -->
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>taglist-maven-plugin</artifactId>
<version>3.2.2</version>
<configuration>
<tagListOptions>
<tagClasses>
<tagClass>
<displayName>Todo Work</displayName>
<tags>
<tag>
<matchString>TODO</matchString>
<matchType>ignoreCase</matchType>
</tag>
<tag>
<matchString>FIXME</matchString>
<matchType>ignoreCase</matchType>
</tag>
</tags>
</tagClass>
</tagClasses>
</tagListOptions>
</configuration>
</plugin>
<!-- Dependency analysis report -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-dependency-plugin</artifactId>
<version>3.10.0</version>
<reportSets>
<reportSet>
<reports>
<report>analyze-report</report>
</reports>
</reportSet>
</reportSets>
</plugin>
</plugins>
</reporting>
</project>
Loading
Loading