Repository navigation
ci: add Javadoc deployment to GitHub Pages and update README badges - #37
Conversation
There was a problem hiding this comment.
🟡 Changes recommended
The README version bump is incomplete—the Standalone CLI Usage examples still reference tsql-scriptdom-core-0.1.0-SNAPSHOT.jar, leaving the documentation internally inconsistent with the 0.1.1 release.
1 open finding
What changed in this PR
This PR adds continuous publishing of the tsql-scriptdom-core API documentation to GitHub Pages and refreshes the README to reflect the released 0.1.1 artifact. It complements the existing release pipeline (release.yml) by hosting browsable Javadoc at https://fupacat.github.io/tsql-scriptdom-java/, reusing the same mvn package -P release build that the release workflow already relies on. The workflow correctly sets up Python before Maven (required by the generate_parser.py source generation step) and uploads the Javadoc from tsql-scriptdom-core/target/apidocs, which is where the release profile's maven-javadoc-plugin writes its HTML output.
Changes:
- New
javadoc-pages.ymlworkflow builds Javadoc and deploys it to GitHub Pages on pushes tomaster,v*.*.*tags, published releases, and manual dispatch, using the standard Pages actions and the recommendedpagesconcurrency group. - README swaps the stale "Maven Central – Snapshot" badge for
ReleaseandJavadocbadges. - README dependency snippets (Maven/Gradle) bumped from
0.1.0-SNAPSHOTto0.1.1.
| File | Description |
|---|---|
| .github/workflows/javadoc-pages.yml | New workflow building target/apidocs and deploying it to GitHub Pages; triggers, permissions, action versions, and build command are consistent with existing workflows. |
| README.md | Adds Release/Javadoc badges and bumps dependency version to 0.1.1; CLI usage examples still reference the old 0.1.0-SNAPSHOT jar name. |
🧠 Review effort: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| <groupId>io.github.fupacat</groupId> | ||
| <artifactId>tsql-scriptdom-core</artifactId> | ||
| <version>0.1.0-SNAPSHOT</version> | ||
| <version>0.1.1</version> |
There was a problem hiding this comment.
🔵 Needs a closer look
It introduces a GitHub Pages deployment workflow and auto-merge/CI automation changes whose runtime success depends on repository Pages and token settings that cannot be verified from the diff, warranting human confirmation.
1 open finding
🧠 Review effort: Balanced
Summary
.github/workflows/javadoc-pages.ymlto build and publishtsql-scriptdom-coreJavadocs (target/apidocs) to GitHub Pages (https://fupacat.github.io/tsql-scriptdom-java/) on pushes tomaster, release tags, published releases, or manual dispatch.README.mdand update Maven/Gradle dependency snippets to0.1.1.