Skip to content

fix(ci): extract packaged javadoc jar for GitHub Pages deployment - #38

Merged
github-actions[bot] merged 1 commit into
masterfrom
fix/javadoc-pages-artifact-path
Oct 12, 2026
Merged

github-actions[bot] merged 1 commit into
masterfrom
fix/javadoc-pages-artifact-path

Conversation

@fupacat

@fupacat fupacat commented Oct 12, 2026

Copy link
Copy Markdown
Owner

Summary

  • maven-javadoc-plugin 3.10+ writes HTML output to target/reports/apidocs rather than target/apidocs.
  • Instead of relying on internal plugin output paths, extract the packaged tsql-scriptdom-core-*-javadoc.jar directly into apidocs-site/ and stamp the POM with the latest release tag version (0.1.1) before generating Javadocs.

Copilot AI balanced review requested due to automatic review settings October 12, 2026 22:29
@github-actions
github-actions Bot enabled auto-merge (squash) October 12, 2026 22:30
@github-actions
github-actions Bot merged commit f83d0ae into master Oct 12, 2026
7 checks passed

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 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 via mvn versions:set, build with -P release, then extract the javadoc jar into apidocs-site/.
  • Upload apidocs-site (instead of tsql-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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants