docs: JavaDoc site on maven.pinont.me - #10
Open
Pinont wants to merge 1 commit into
Open
Conversation
Generate API docs with javadoc:javadoc and copy them into Pinont/singularity-maven under /javadoc/singularitylib/ so they sit beside the snapshot Maven repo without using this repo's GitHub Pages (that URL is the pinont.me portfolio). Co-authored-by: Nonnipat Tangrojjanakhajorn <contact@pinont.me>
There was a problem hiding this comment.
🟡 Changes recommended
The new publish workflow can silently succeed when version parsing or the Pages rebuild trigger fails, which can leave the hosted docs stale without failing CI.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
Adds a public, Maven-site-hosted JavaDoc documentation site for SingularityLib by generating JavaDoc HTML in CI and publishing it into the Pinont/singularity-maven gh-pages tree under /javadoc/singularitylib/, alongside a small landing page and updated README links.
Changes:
- Add a landing page and redirect page under
docs/for the hosted JavaDoc site. - Add a new GitHub Actions workflow to build JavaDoc HTML and publish it to
Pinont/singularity-maven(gh-pages) under/javadoc/singularitylib/. - Update README and Maven Javadoc plugin configuration to align with the new docs publishing flow.
File summaries
| File | Description |
|---|---|
| README.md | Adds a docs badge and links to the hosted JavaDoc and fallback javadoc.io. |
| pom.xml | Centralizes maven-javadoc-plugin configuration for jar + HTML generation behavior. |
| docs/javadoc-root.html | Adds a lightweight redirect entry point for the /javadoc/ root. |
| docs/index.html | Adds a styled landing page with install coordinates and JavaDoc links. |
| .github/workflows/publish-javadoc.yml | New workflow to generate and publish JavaDoc HTML to the Pages-backed Maven repo. |
| .github/workflows/pages-repo.yml | Adds concurrency coordination/comments to avoid racing with JavaDoc publishing. |
Review details
- Files reviewed: 6/6 changed files
- Comments generated: 2
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+39
to
+40
| VERSION=$(mvn -q -DforceStdout help:evaluate -Dexpression=project.version) | ||
| echo "version=${VERSION}" >> "$GITHUB_OUTPUT" |
Comment on lines
+108
to
+111
| curl -s -X POST \ | ||
| -H "Authorization: Bearer ${{ secrets.MAVEN_REPO_TOKEN }}" \ | ||
| -H "Accept: application/vnd.github+json" \ | ||
| https://api.github.com/repos/Pinont/singularity-maven/pages/builds -o /dev/null -w "%{http_code}\n" |
This was referenced Sep 1, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
Ship a public docs site with generated JavaDoc HTML, plus a small landing page that matches the Maven Central install story on
main. This repo’s GitHub Pages URL (https://pinont.github.io/SingularityLib/) 301s to the pinont.me portfolio, so JavaDoc is not published there.What
docs/index.html(Central coordinates, README install link, JavaDoc entry)..github/workflows/publish-javadoc.yml: on push tomainandworkflow_dispatch, runsmvn javadoc:javadocand copies HTML intoPinont/singularity-mavengh-pagesunder/javadoc/singularitylib/only (Maven group pathsio//com/untouched).maven-javadoc-pluginstill attaches the javadoc jar for future Central publishes (failOnErrorremains false).pages-repo.ymlis unchanged in behavior; it only shares a concurrency group so Maven-layout and JavaDoc pushes do not race, and comments that/javadoc/must not be deleted.Intended URLs (after merge + first
publish-javadocrun)Not using
https://pinont.github.io/SingularityLib/(portfolio).Out of scope
release.ymluntouched.Verify
mvn javadoc:javadocsucceeds locally (warnings only; HTML attarget/site/apidocs/index.html).mvn javadoc:jarstill producessingularitylib-*-javadoc.jar.