Skip to content

Commit 8322fd7

Browse files
john-manackjohn-manack
authored
Merge pull request #1564 from CMSgov/QPPA-10750-expose-javadocs
QPPA-10750: Expose javadoc functionality
2 parents a4d4414 + cc0ac0c commit 8322fd7

6 files changed

Lines changed: 91 additions & 81 deletions

File tree

‎.github/workflows/ci-build.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,10 @@ jobs:
3232
run: rm -vrf ~/.m2
3333

3434
- name: Maven build
35-
run: mvn package -Dmaven.test.skip -Djacoco.skip=true
35+
run: mvn package -Dmaven.test.skip -Djacoco.skip=true -Dskip.generate=true
3636

3737
- name: Run Unit tests & Sonar Scan
38-
run: mvn --batch-mode verify
38+
run: mvn --batch-mode verify -Dskip.generate=true
3939

4040
- name: Run integration tests
4141
run: mvn --batch-mode test -Pintegration

‎Dockerfile‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ COPY test-coverage/ /usr/src/app/test-coverage/
3434
COPY tools/docker/docker-artifacts/ /usr/src/app/tools/docker/docker-artifacts/
3535
WORKDIR /usr/src/app/
3636

37-
RUN /usr/local/bin/mvn-entrypoint.sh mvn install -Dmaven.test.skip -Djacoco.skip=true > /dev/null
37+
RUN /usr/local/bin/mvn-entrypoint.sh mvn install -Dmaven.test.skip -Djacoco.skip=true -Dskip.generate=true > /dev/null
3838

3939
# Final stage
4040
FROM eclipse-temurin:17-jre

‎commons/src/main/resources/measures-data.json‎

Lines changed: 24 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -14081,8 +14081,10 @@
1408114081
"primarySteward": "College of American Pathologists",
1408214082
"isInverse": false,
1408314083
"isRiskAdjusted": false,
14084-
"isIcdImpacted": false,
14085-
"icdImpacted": [],
14084+
"isIcdImpacted": true,
14085+
"icdImpacted": [
14086+
"registry"
14087+
],
1408614088
"isClinicalGuidelineChanged": false,
1408714089
"clinicalGuidelineChanged": [],
1408814090
"companionMeasureId": [],
@@ -19221,7 +19223,8 @@
1922119223
"companionMeasureId": [],
1922219224
"allowedPrograms": [
1922319225
"mips",
19224-
"app1"
19226+
"app1",
19227+
"appPlus"
1922519228
],
1922619229
"submissionMethods": [
1922719230
"certifiedSurveyVendor"
@@ -19260,7 +19263,8 @@
1926019263
"companionMeasureId": [],
1926119264
"allowedPrograms": [
1926219265
"mips",
19263-
"app1"
19266+
"app1",
19267+
"appPlus"
1926419268
],
1926519269
"submissionMethods": [
1926619270
"certifiedSurveyVendor"
@@ -19299,7 +19303,8 @@
1929919303
"companionMeasureId": [],
1930019304
"allowedPrograms": [
1930119305
"mips",
19302-
"app1"
19306+
"app1",
19307+
"appPlus"
1930319308
],
1930419309
"submissionMethods": [
1930519310
"certifiedSurveyVendor"
@@ -19338,7 +19343,8 @@
1933819343
"companionMeasureId": [],
1933919344
"allowedPrograms": [
1934019345
"mips",
19341-
"app1"
19346+
"app1",
19347+
"appPlus"
1934219348
],
1934319349
"submissionMethods": [
1934419350
"certifiedSurveyVendor"
@@ -19377,7 +19383,8 @@
1937719383
"companionMeasureId": [],
1937819384
"allowedPrograms": [
1937919385
"mips",
19380-
"app1"
19386+
"app1",
19387+
"appPlus"
1938119388
],
1938219389
"submissionMethods": [
1938319390
"certifiedSurveyVendor"
@@ -19416,7 +19423,8 @@
1941619423
"companionMeasureId": [],
1941719424
"allowedPrograms": [
1941819425
"mips",
19419-
"app1"
19426+
"app1",
19427+
"appPlus"
1942019428
],
1942119429
"submissionMethods": [
1942219430
"certifiedSurveyVendor"
@@ -19455,7 +19463,8 @@
1945519463
"companionMeasureId": [],
1945619464
"allowedPrograms": [
1945719465
"mips",
19458-
"app1"
19466+
"app1",
19467+
"appPlus"
1945919468
],
1946019469
"submissionMethods": [
1946119470
"certifiedSurveyVendor"
@@ -19494,7 +19503,8 @@
1949419503
"companionMeasureId": [],
1949519504
"allowedPrograms": [
1949619505
"mips",
19497-
"app1"
19506+
"app1",
19507+
"appPlus"
1949819508
],
1949919509
"submissionMethods": [
1950019510
"certifiedSurveyVendor"
@@ -19533,7 +19543,8 @@
1953319543
"companionMeasureId": [],
1953419544
"allowedPrograms": [
1953519545
"mips",
19536-
"app1"
19546+
"app1",
19547+
"appPlus"
1953719548
],
1953819549
"submissionMethods": [
1953919550
"certifiedSurveyVendor"
@@ -19572,7 +19583,8 @@
1957219583
"companionMeasureId": [],
1957319584
"allowedPrograms": [
1957419585
"mips",
19575-
"app1"
19586+
"app1",
19587+
"appPlus"
1957619588
],
1957719589
"submissionMethods": [
1957819590
"certifiedSurveyVendor"

‎converter/pom.xml‎

Lines changed: 31 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -34,25 +34,40 @@
3434
<artifactId>spotbugs-maven-plugin</artifactId>
3535
</plugin>
3636

37-
<plugin>
38-
<groupId>gov.cms.qpp.conversion</groupId>
39-
<artifactId>generate-maven-plugin</artifactId>
40-
<version>${project.version}</version>
41-
<configuration>
42-
<baseDir>${basedir}/../tools/docker/docker-artifacts/</baseDir>
43-
</configuration>
44-
<executions>
45-
<execution>
46-
<phase>${maven.generate.phase}</phase>
47-
<goals>
48-
<goal>generateErrorCodeDoc</goal>
49-
</goals>
50-
</execution>
51-
</executions>
52-
</plugin>
5337
</plugins>
5438
</build>
5539

40+
<profiles>
41+
<profile>
42+
<id>with-generate-plugin</id>
43+
<activation>
44+
<property>
45+
<name>!skip.generate</name>
46+
</property>
47+
</activation>
48+
<build>
49+
<plugins>
50+
<plugin>
51+
<groupId>gov.cms.qpp.conversion</groupId>
52+
<artifactId>generate-maven-plugin</artifactId>
53+
<version>${project.version}</version>
54+
<configuration>
55+
<baseDir>${basedir}/../tools/docker/docker-artifacts/</baseDir>
56+
</configuration>
57+
<executions>
58+
<execution>
59+
<phase>${maven.generate.phase}</phase>
60+
<goals>
61+
<goal>generateErrorCodeDoc</goal>
62+
</goals>
63+
</execution>
64+
</executions>
65+
</plugin>
66+
</plugins>
67+
</build>
68+
</profile>
69+
</profiles>
70+
5671
<dependencies>
5772
<dependency>
5873
<groupId>com.google.code.findbugs</groupId>

‎pom.xml‎

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,15 +25,16 @@
2525
<maven.compiler.target>${java.version}</maven.compiler.target>
2626
<io.rest-assured.version>4.1.2</io.rest-assured.version>
2727
<argLine/>
28+
<javadoc.skip>false</javadoc.skip>
2829
</properties>
2930

3031
<modules>
3132
<module>commons</module>
3233
<module>test-commons</module>
34+
<module>generate</module>
3335
<module>converter</module>
3436
<module>commandline</module>
3537
<module>rest-api</module>
36-
<module>generate</module>
3738
<module>test-coverage</module>
3839
</modules>
3940

@@ -202,6 +203,18 @@
202203
<quiet>true</quiet>
203204
</configuration>
204205
</execution>
206+
<execution>
207+
<id>aggregate</id>
208+
<goals>
209+
<goal>aggregate</goal>
210+
</goals>
211+
<phase>prepare-package</phase>
212+
<configuration>
213+
<doclint>none</doclint>
214+
<quiet>true</quiet>
215+
<skip>${javadoc.skip}</skip>
216+
</configuration>
217+
</execution>
205218
</executions>
206219
</plugin>
207220
</plugins>

‎rest-api/pom.xml‎

Lines changed: 19 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,6 @@
3030

3131
<properties>
3232
<requiredCodeCoverage>0.90</requiredCodeCoverage>
33-
<!-- Allow disabling inclusion of Javadoc static resources -->
34-
<skipJavadocResources>false</skipJavadocResources>
3533

3634
<!-- For documentation only; actual coordination is done by the BOMs below -->
3735
<spring-framework.version>6.2.11</spring-framework.version>
@@ -66,56 +64,38 @@
6664
<execution><goals><goal>repackage</goal></goals></execution>
6765
</executions>
6866
</plugin>
69-
<!-- Generate unified Javadoc (all modules) and copy into static /v3/javadoc. -->
67+
68+
<!-- Static analysis helpers (inherit configuration from parent) -->
69+
<plugin>
70+
<groupId>org.gaul</groupId>
71+
<artifactId>modernizer-maven-plugin</artifactId>
72+
</plugin>
73+
<plugin>
74+
<groupId>com.github.spotbugs</groupId>
75+
<artifactId>spotbugs-maven-plugin</artifactId>
76+
</plugin>
7077
<plugin>
7178
<groupId>org.apache.maven.plugins</groupId>
7279
<artifactId>maven-javadoc-plugin</artifactId>
73-
<executions>
74-
<execution>
75-
<id>unified-site</id>
76-
<phase>prepare-package</phase>
77-
<goals>
78-
<goal>javadoc</goal>
79-
</goals>
80-
<configuration>
81-
<skip>${skipJavadocResources}</skip>
82-
<doctitle>QPP Conversion Tool API</doctitle>
83-
<windowtitle>QPP Conversion Tool API</windowtitle>
84-
<quiet>true</quiet>
85-
<doclint>none</doclint>
86-
<failOnError>false</failOnError>
87-
<!-- Explicitly stitch modules together. Order does not matter; colon separated. -->
88-
<sourcepath>${project.basedir}/../commons/src/main/java:${project.basedir}/../converter/src/main/java:${project.basedir}/../commandline/src/main/java:${project.basedir}/src/main/java</sourcepath>
89-
<!-- Limit to our Java package namespace -->
90-
<subpackages>gov.cms.qpp.conversion</subpackages>
91-
<encoding>UTF-8</encoding>
92-
<!-- For the 'javadoc' goal the correct parameter is outputDirectory (reportOutputDirectory is ignored). -->
93-
<outputDirectory>${project.build.directory}/aggregated-javadoc</outputDirectory>
94-
<additionalJOptions>
95-
<!-- Avoid overly strict doclint on JDK17 while legacy comments are cleaned up -->
96-
<additionalJOption>-Xdoclint:none</additionalJOption>
97-
</additionalJOptions>
98-
</configuration>
99-
</execution>
100-
</executions>
10180
</plugin>
81+
82+
<!-- Copy aggregated javadoc from parent to rest-api resources -->
10283
<plugin>
10384
<groupId>org.apache.maven.plugins</groupId>
10485
<artifactId>maven-resources-plugin</artifactId>
10586
<version>3.3.1</version>
10687
<executions>
10788
<execution>
108-
<id>copy-aggregated-javadoc</id>
109-
<!-- Must run AFTER aggregate javadoc (prepare-package) so we copy the freshly generated index.html, not a stale or previous custom landing page. -->
110-
<phase>prepare-package</phase>
111-
<goals><goal>copy-resources</goal></goals>
89+
<id>copy-javadoc</id>
90+
<phase>process-classes</phase>
91+
<goals>
92+
<goal>copy-resources</goal>
93+
</goals>
11294
<configuration>
113-
<skip>${skipJavadocResources}</skip>
114-
<outputDirectory>${project.build.outputDirectory}/public/v3/javadoc</outputDirectory>
95+
<outputDirectory>${project.build.outputDirectory}/static/v3/javadoc</outputDirectory>
11596
<resources>
11697
<resource>
117-
<!-- The javadoc goal writes into aggregated-javadoc/apidocs -->
118-
<directory>${project.build.directory}/aggregated-javadoc/apidocs</directory>
98+
<directory>${project.basedir}/../target/reports/apidocs</directory>
11999
<filtering>false</filtering>
120100
</resource>
121101
</resources>
@@ -124,16 +104,6 @@
124104
</executions>
125105
</plugin>
126106

127-
<!-- Static analysis helpers (inherit configuration from parent) -->
128-
<plugin>
129-
<groupId>org.gaul</groupId>
130-
<artifactId>modernizer-maven-plugin</artifactId>
131-
</plugin>
132-
<plugin>
133-
<groupId>com.github.spotbugs</groupId>
134-
<artifactId>spotbugs-maven-plugin</artifactId>
135-
</plugin>
136-
137107
<!-- Enforce a single version per GA to catch dependency drift early -->
138108
<plugin>
139109
<groupId>org.apache.maven.plugins</groupId>

0 commit comments

Comments
 (0)