Skip to content

Commit 69f2c2b

Browse files
authored
Javadoc generation before upload to staging server (#788)
Signed-off-by: Radek Felcman <[email protected]>
1 parent 986fd1c commit 69f2c2b

File tree

1 file changed

+34
-3
lines changed

1 file changed

+34
-3
lines changed

uploadToNexus.xml

+34-3
Original file line numberDiff line numberDiff line change
@@ -395,6 +395,7 @@
395395
<param name="artifactVersion" value="${maven.version}"/>
396396
<param name="artifact" value="${maven.2.common.plugins.dir}/${hermes.prefix}_${hermes.version}.jar"/>
397397
<param name="artifactSrc" value="${maven.2.common.plugins.dir}/${hermes.prefix}.source_${hermes.version}.jar"/>
398+
<param name="artifactJavadoc" value="${maven.2.common.plugins.dir}/${hermes.prefix}.javadocs_${hermes.version}.jar"/>
398399
<param name="artifactName" value="${hermes.name}"/>
399400
<param name="dependencies" value=""/>
400401
</antcall>
@@ -404,6 +405,7 @@
404405
<param name="artifactVersion" value="${maven.version}"/>
405406
<param name="artifact" value="${maven.2.common.plugins.dir}/${antlr.prefix}_${antlr.version}.jar"/>
406407
<param name="artifactSrc" value="${maven.2.common.plugins.dir}/${antlr.prefix}.source_${antlr.version}.jar"/>
408+
<param name="artifactJavadoc" value="${maven.2.common.plugins.dir}/${antlr.prefix}.javadocs_${antlr.version}.jar"/>
407409
<param name="artifactName" value="${antlr.name}"/>
408410
<param name="dependencies" value=""/>
409411
</antcall>
@@ -413,6 +415,7 @@
413415
<param name="artifactVersion" value="${maven.version}"/>
414416
<param name="artifact" value="${maven.2.common.plugins.dir}/${asm.prefix}_${asm.version}.jar"/>
415417
<param name="artifactSrc" value="${maven.2.common.plugins.dir}/${asm.prefix}.source_${asm.version}.jar"/>
418+
<param name="artifactJavadoc" value="${maven.2.common.plugins.dir}/${asm.prefix}.javadocs_${asm.version}.jar"/>
416419
<param name="artifactName" value="${asm.name}"/>
417420
<param name="dependencies" value=""/>
418421
</antcall>
@@ -422,6 +425,7 @@
422425
<param name="artifactVersion" value="${maven.version}"/>
423426
<param name="artifact" value="${maven.2.common.plugins.dir}/org.eclipse.persistence.core_${version.string}.jar"/>
424427
<param name="artifactSrc" value="${maven.2.common.plugins.dir}/org.eclipse.persistence.core.source_${version.string}.jar"/>
428+
<param name="artifactJavadoc" value="${maven.2.common.plugins.dir}/org.eclipse.persistence.core.javadocs_${version.string}.jar"/>
425429
<param name="artifactName" value="EclipseLink Core"/>
426430
<param name="dependencies" value="${core.dependencies}"/>
427431
</antcall>
@@ -431,10 +435,11 @@
431435
<param name="artifactVersion" value="${maven.version}"/>
432436
<param name="artifact" value="${maven.2.common.plugins.dir}/${oraclebndl.prefix}_${oraclebndl.version}.jar"/>
433437
<param name="artifactSrc" value="${maven.2.common.plugins.dir}/${oraclebndl.prefix}.source_${oraclebndl.version}.jar"/>
438+
<param name="artifactJavadoc" value="${maven.2.common.plugins.dir}/${oraclebndl.prefix}.javadocs_${oraclebndl.version}.jar"/>
434439
<param name="artifactName" value="${oraclebndl.name}"/>
435440
<param name="dependencies" value="${oracle.dependencies}"/>
436441
</antcall>
437-
<antcall target="upload-artifact">
442+
<antcall target="upload-artifact-with-javadoc">
438443
<param name="groupId" value="org.eclipse.persistence"/>
439444
<param name="artifactId" value="${oraclenosql.prefix}"/>
440445
<param name="artifactVersion" value="${maven.version}"/>
@@ -460,6 +465,7 @@
460465
<param name="artifactVersion" value="${maven.version}"/>
461466
<param name="artifact" value="${maven.2.common.plugins.dir}/org.eclipse.persistence.jpa_${version.string}.jar"/>
462467
<param name="artifactSrc" value="${maven.2.common.plugins.dir}/org.eclipse.persistence.jpa.source_${version.string}.jar"/>
468+
<param name="artifactJavadoc" value="${maven.2.common.plugins.dir}/org.eclipse.persistence.jpa.javadocs_${version.string}.jar"/>
463469
<param name="artifactName" value="EclipseLink JPA"/>
464470
<param name="dependencies" value="${jpa.dependencies}"/>
465471
</antcall>
@@ -479,6 +485,7 @@
479485
<param name="artifactVersion" value="${maven.version}"/>
480486
<param name="artifact" value="${maven.2.common.plugins.dir}/org.eclipse.persistence.jpa.modelgen_${version.string}.jar"/>
481487
<param name="artifactSrc" value="${maven.2.common.plugins.dir}/org.eclipse.persistence.jpa.modelgen.source_${version.string}.jar"/>
488+
<param name="artifactJavadoc" value="${maven.2.common.plugins.dir}/org.eclipse.persistence.jpa.modelgen.javadocs_${version.string}.jar"/>
482489
<param name="artifactName" value="EclipseLink JPA Modelgen (non-OSGi)"/>
483490
<param name="dependencies" value="${modelgen.dependencies}"/>
484491
</antcall>
@@ -488,6 +495,7 @@
488495
<param name="artifactVersion" value="${maven.version}"/>
489496
<param name="artifact" value="${maven.2.common.plugins.dir}/org.eclipse.persistence.moxy_${version.string}.jar"/>
490497
<param name="artifactSrc" value="${maven.2.common.plugins.dir}/org.eclipse.persistence.moxy.source_${version.string}.jar"/>
498+
<param name="artifactJavadoc" value="${maven.2.common.plugins.dir}/org.eclipse.persistence.moxy.javadocs_${version.string}.jar"/>
491499
<param name="artifactName" value="EclipseLink Moxy"/>
492500
<param name="dependencies" value="${moxy.dependencies}"/>
493501
</antcall>
@@ -497,6 +505,7 @@
497505
<param name="artifactVersion" value="${maven.version}"/>
498506
<param name="artifact" value="${maven.2.common.plugins.dir}/org.eclipse.persistence.sdo_${version.string}.jar"/>
499507
<param name="artifactSrc" value="${maven.2.common.plugins.dir}/org.eclipse.persistence.sdo.source_${version.string}.jar"/>
508+
<param name="artifactJavadoc" value="${maven.2.common.plugins.dir}/org.eclipse.persistence.sdo.javadocs_${version.string}.jar"/>
500509
<param name="artifactName" value="EclipseLink SDO"/>
501510
<param name="dependencies" value="${sdo.dependencies}"/>
502511
</antcall>
@@ -506,6 +515,7 @@
506515
<param name="artifactVersion" value="${maven.version}"/>
507516
<param name="artifact" value="${maven.2.common.plugins.dir}/org.eclipse.persistence.dbws_${version.string}.jar"/>
508517
<param name="artifactSrc" value="${maven.2.common.plugins.dir}/org.eclipse.persistence.dbws.source_${version.string}.jar"/>
518+
<param name="artifactJavadoc" value="${maven.2.common.plugins.dir}/org.eclipse.persistence.dbws.javadocs_${version.string}.jar"/>
509519
<param name="artifactName" value="EclipseLink DBWS"/>
510520
<param name="dependencies" value="${dbws.dependencies}"/>
511521
</antcall>
@@ -515,6 +525,7 @@
515525
<param name="artifactVersion" value="${maven.version}"/>
516526
<param name="artifact" value="${maven.2.util.plugins.dir}/${oracleddl.prefix}_${oracleddl.version}.jar"/>
517527
<param name="artifactSrc" value="${maven.2.util.plugins.dir}/${oracleddl.prefix}.source_${oracleddl.version}.jar"/>
528+
<param name="artifactJavadoc" value="${maven.2.util.plugins.dir}/${oracleddl.prefix}.javadocs_${oracleddl.version}.jar"/>
518529
<param name="artifactName" value="${oracleddl.name}"/>
519530
<param name="dependencies" value=""/>
520531
</antcall>
@@ -524,6 +535,7 @@
524535
<param name="artifactVersion" value="${maven.version}"/>
525536
<param name="artifact" value="${maven.2.common.plugins.dir}/org.eclipse.persistence.dbws.builder_${version.string}.jar"/>
526537
<param name="artifactSrc" value="${maven.2.common.plugins.dir}/org.eclipse.persistence.dbws.builder.source_${version.string}.jar"/>
538+
<param name="artifactJavadoc" value="${maven.2.common.plugins.dir}/org.eclipse.persistence.dbws.builder.javadocs_${version.string}.jar"/>
527539
<param name="artifactName" value="EclipseLink DBWS Builder"/>
528540
<param name="dependencies" value="${builder.dependencies}"/>
529541
</antcall>
@@ -533,6 +545,7 @@
533545
<param name="artifactVersion" value="${maven.version}"/>
534546
<param name="artifact" value="${maven.2.common.plugins.dir}/org.eclipse.persistence.extension_${version.string}.jar"/>
535547
<param name="artifactSrc" value="${maven.2.common.plugins.dir}/org.eclipse.persistence.extension.source_${version.string}.jar"/>
548+
<param name="artifactJavadoc" value="${maven.2.common.plugins.dir}/org.eclipse.persistence.extension.javadocs_${version.string}.jar"/>
536549
<param name="artifactName" value="EclipseLink Extensions"/>
537550
<param name="dependencies" value="${extension.dependencies}"/>
538551
</antcall>
@@ -553,13 +566,30 @@
553566
</copy>
554567
</target>
555568

569+
<!-- Generates missing Javadoc. jakarta.oss.sonatype.org requires it (repository closing rules)-->
570+
<target name="prepare-javadoc">
571+
<property name="src.tmp" value="prepare-javadoc.src.tmp"/>
572+
<property name="doc.tmp" value="prepare-javadoc.doc.tmp"/>
573+
574+
<delete dir="${src.tmp}" failonerror="false"/>
575+
<delete dir="${doc.tmp}" failonerror="false"/>
576+
<unjar src="${artifactSrc}" dest="${src.tmp}"/>
577+
<javadoc sourcepath="${src.tmp}" destdir="${doc.tmp}" version="true" additionalparam="-Xdoclint:none" packagenames="org.eclipse.persistence.*" noindex="true">
578+
</javadoc>
579+
<zip destfile="${artifactJavadoc}">
580+
<!-- miscellaneous files -->
581+
<zipfileset dir="${doc.tmp}/"/>
582+
</zip>
583+
<echo message="java doc has been generated!"/>
584+
</target>
585+
556586
<!-- Uploads a single artifact & source to maven repository only if one doesn't already exist -->
557587
<!-- Removed "upload-release-artifact" because it depended upon filesystem access. Need a mechanism -->
558588
<!-- to verify an artifact is already uploaded to Nexus server. For now, am hoping nexus is smart enough -->
559589
<!-- to refuse redeployment. (Not hopeful though, seems too restrictive). -->
560590

561591
<!-- Uploads a single artifact & source to maven repository -->
562-
<target name="upload-artifact" depends="prepare-pom, ua-snapshot, ua-staging, us-staging">
592+
<target name="upload-artifact" depends="prepare-pom, prepare-javadoc, uawj-snapshot, ua-staging, us-staging, uj-staging">
563593
<!-- cleanup -->
564594
<delete file="pom.xml"/>
565595
</target>
@@ -570,7 +600,8 @@
570600
<artifact:deploy file="${artifact}">
571601
<artifact:remoteRepository id="${snapshotId}" url="${snapshotURL}" />
572602
<artifact:pom id="maven.project" file="pom.xml" />
573-
<artifact:attach file="${artifactSrc}" classifier="sources"/>
603+
<artifact:attach file="${artifactSrc}" type="jar" classifier="sources"/>
604+
<artifact:attach file="${artifactJavadoc}" type="jar" classifier="javadoc"/>
574605
</artifact:deploy>
575606
</target>
576607

0 commit comments

Comments
 (0)