ci: publish only the public Java API with the released version#160
Merged
Conversation
The Java Javadoc showed "0.0.0-SNAPSHOT" and an inconsistent module list (the internal engine, a single dialect SPI, the test-support module). - Stamp the released version (newest versions.json entry) via -Drevision on the build and aggregate, so the docs read e.g. "Storm Framework 1.11.6 API". - Aggregate only storm-foundation (st.orm, st.orm.mapping) and storm-java21 (st.orm.repository, st.orm.template) -- the public Java API -- excluding the internal core, dialect SPIs, test, metamodel-processor, and Spring/Jackson. - Point the docs "Browse the Javadoc" link at /api/java/storm.foundation/st/orm/package-summary.html.
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
1 participant
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.
Follow-ups on the now-working
/api/javaJavadoc — it was showing0.0.0-SNAPSHOTand a messy module list.Changes
Version — the Javadoc title read
Storm Framework 0.0.0-SNAPSHOT API(the pom<revision>, which staysSNAPSHOTon main). Now stamps the released version (newestversions.jsonentry) via-Drevisionon both the build and the aggregate →Storm Framework 1.11.6 API.Modules — the aggregate documented an inconsistent set: the internal engine (
storm.core), only one dialect (storm.mysql, the only dialect that happens to export a package), and thestorm.testsupport module. Curated to just the public Java API:storm.foundation→st.orm,st.orm.mapping(Entity, Ref, annotations)storm.java→st.orm.repository,st.orm.template(ORMTemplate, query builder, repositories)Everything else is excluded (internal core, dialect SPIs, test, metamodel-processor, Spring/Jackson integrations). Two named modules keep javadoc in module mode so pages retain their
storm.foundation/…paths.Docs link — "Browse the Javadoc" now points at
/api/java/storm.foundation/st/orm/package-summary.html(thest.ormoverview) instead of the module index, indocs/andversion-1.11.6/.Verification (local
mvn install+javadoc:aggregateat 1.11.6)storm.foundation+storm.java; packages:st.orm,st.orm.mapping,st.orm.repository,st.orm.template.storm.foundation/st/orm/package-summary.htmlpresent;Entity,Ref,ORMTemplate,EntityRepositoryall documented.docs.ymlis valid YAML; Docusaurus build passes.Takes effect on the next docs deploy (after merge).