Repository navigation
fix(ci): extract packaged javadoc jar for GitHub Pages deployment - #38
Conversation
There was a problem hiding this comment.
🟢 Approved
The CI-only change is small and self-consistent — the javadoc jar glob matches release.yml, versions:set propagates across the reactor, and fetch-depth: 0 correctly enables tag resolution, with no detected defects.
0 open findings
What changed in this PR
This PR fixes the GitHub Pages Javadoc deployment workflow. Because maven-javadoc-plugin 3.10+ (the repo pins 3.12.0) writes HTML to target/reports/apidocs instead of the previously-uploaded target/apidocs, the Pages job was publishing a stale/empty directory. Instead of tracking the plugin's internal output path, the workflow now extracts the packaged tsql-scriptdom-core-*-javadoc.jar into apidocs-site/ and uploads that. It also stamps the POM with the latest release tag version before building so the docs reflect a real release version.
Changes:
- Fetch full git history/tags (
fetch-depth: 0) so the latest release tag can be resolved. - Derive the version from
git describe --tags, apply it viamvn versions:set, build with-P release, then extract the javadoc jar intoapidocs-site/. - Upload
apidocs-site(instead oftsql-scriptdom-core/target/apidocs) as the Pages artifact.
| File | Description |
|---|---|
| .github/workflows/javadoc-pages.yml | Resolves latest tag, stamps POM version, builds the release javadoc jar, and extracts it to apidocs-site/ for Pages upload. |
🧠 Review effort: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Summary
maven-javadoc-plugin3.10+ writes HTML output totarget/reports/apidocsrather thantarget/apidocs.tsql-scriptdom-core-*-javadoc.jardirectly intoapidocs-site/and stamp the POM with the latest release tag version (0.1.1) before generating Javadocs.