Skip to content

Commit c4a28fd

Browse files
committed
docs: add aggregated Javadoc generation via site-javadoc profile
Add a `site-javadoc` Maven profile that generates unified cross-module Javadoc using maven-javadoc-plugin's aggregate goal. Cross-module @see and {@link} references resolve as navigable HTML links. - Add site-javadoc profile to parent POM with aggregate goal - Move Javadoc menu entry from global menu to per-version menu in dev.yml - Add placeholder docs/public/dev/apidocs/index.html for unreleased versions - Update RELEASE.md with Javadoc generation steps for major/minor releases - Add Javadoc aggregation verification step to CI release profile workflow
1 parent 609c2cd commit c4a28fd

4,711 files changed

Lines changed: 1242013 additions & 8 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/workflows/build-with-release-profile.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,9 @@ jobs:
4646
-Dgpg.skip=true
4747
-Drelease.auto.publish=false
4848
49+
- name: Verify aggregated Javadoc generation
50+
run: mvn -B javadoc:aggregate -Psite-javadoc
51+
4952
- name: Prepare PR info
5053
run: |
5154
mkdir -p pr_info

RELEASE.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -186,6 +186,24 @@ Update the previous default version's data file (e.g., `docs/data/versions/OLD_V
186186

187187
Review the new version's content for accuracy — ensure all pages reflect features available in this release.
188188

189+
#### Generate Javadoc (major/minor releases only)
190+
191+
For major and minor releases (X.Y.0.Final), generate aggregated Javadoc. Skip this step for micro/patch releases (X.Y.Z.Final where Z > 0) — the API surface doesn't change meaningfully.
192+
193+
```bash
194+
# Generate aggregated Javadoc (from the tagged commit)
195+
mvn javadoc:aggregate -Psite-javadoc
196+
197+
# Copy to the release version directory (overwrites the placeholder)
198+
cp -r docs/public/dev/apidocs docs/public/X.Y.Z.Final/apidocs
199+
200+
# Commit the generated Javadoc
201+
git add docs/public/X.Y.Z.Final/apidocs
202+
git commit -m "docs: add Javadoc for X.Y.Z.Final"
203+
```
204+
205+
The Javadoc menu entry in the version's data file is inherited automatically from dev — no manual editing needed.
206+
189207
### 10. Increment to Next SNAPSHOT
190208

191209
Prepare repository for next development cycle:

docs/data/menu.yml

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,6 @@ items:
77
path: "/announces"
88
icon: "fa-regular fa-newspaper"
99
position: "bottom"
10-
- title: "Javadoc"
11-
path: "https://javadoc.io/doc/org.a2aproject.sdk"
12-
icon: "fa-solid fa-file-code"
13-
target: "_blank"
14-
position: "bottom"
1510
- title: "Community"
1611
path: "/community"
1712
icon: "fa-solid fa-users"

docs/data/versions/1.0.0.Final.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,3 +28,7 @@ menu:
2828
- title: "Examples"
2929
path: "/examples"
3030
icon: "fa-solid fa-flask"
31+
- title: "Javadoc"
32+
path: "/apidocs/"
33+
icon: "fa-solid fa-file-code"
34+
target: "_blank"

docs/data/versions/1.1.0.Final.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,3 +31,7 @@ menu:
3131
- title: "Examples"
3232
path: "/examples"
3333
icon: "fa-solid fa-flask"
34+
- title: "Javadoc"
35+
path: "/apidocs/"
36+
icon: "fa-solid fa-file-code"
37+
target: "_blank"

docs/data/versions/dev.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,3 +31,7 @@ menu:
3131
- title: "Examples"
3232
path: "/examples"
3333
icon: "fa-solid fa-flask"
34+
- title: "Javadoc"
35+
path: "/apidocs/"
36+
icon: "fa-solid fa-file-code"
37+
target: "_blank"

docs/public/1.0.0.Final/apidocs/allclasses-index.html

Lines changed: 3649 additions & 0 deletions
Large diffs are not rendered by default.

docs/public/1.0.0.Final/apidocs/allpackages-index.html

Lines changed: 290 additions & 0 deletions
Large diffs are not rendered by default.

docs/public/1.0.0.Final/apidocs/constant-values.html

Lines changed: 2881 additions & 0 deletions
Large diffs are not rendered by default.

docs/public/1.0.0.Final/apidocs/deprecated-list.html

Lines changed: 366 additions & 0 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)