Skip to content

Commit df54846

Browse files
kwinkwin
committed
Enable Javadoc in GHA
Fix javadoc issues
1 parent 2badefb commit df54846

File tree

5 files changed

+30
-22
lines changed

5 files changed

+30
-22
lines changed

‎.github/workflows/maven.yml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ jobs:
4040

4141
- name: Build with Maven
4242
if: '!matrix.isMainBuildEnv'
43-
run: mvn -e -B -V -Pintegration-tests clean verify
43+
run: mvn -e -B -V clean verify -Pintegration-tests -Pjavadoc
4444
- name: Build and Analyse with Maven
4545
if: github.ref != 'refs/heads/develop' && matrix.isMainBuildEnv
4646
env:
@@ -56,7 +56,7 @@ jobs:
5656
ACTOOL_IMS_IT_CLIENTSECRET: ${{ secrets.ACTOOL_IMS_IT_CLIENTSECRET }}
5757
ACTOOL_IMS_IT_PRODUCTPROFILE: ${{ vars.ACTOOL_IMS_IT_PRODUCTPROFILE }}
5858
ACTOOL_IMS_IT_USERID: ${{ vars.ACTOOL_IMS_IT_USERID }}
59-
run: mvn -e -B -V clean verify org.sonarsource.scanner.maven:sonar-maven-plugin:sonar -Dsonar.projectKey=Netcentric_accesscontroltool -Dsonar.organization=netcentric -Dsonar.host.url=https://sonarcloud.io -DnvdApiKeyEnvironmentVariable=NVD_API_KEY -Pdependency-check,coverage-report,integration-tests
59+
run: mvn -e -B -V clean verify org.sonarsource.scanner.maven:sonar-maven-plugin:sonar -Dsonar.projectKey=Netcentric_accesscontroltool -Dsonar.organization=netcentric -Dsonar.host.url=https://sonarcloud.io -DnvdApiKeyEnvironmentVariable=NVD_API_KEY -Pdependency-check -Pcoverage-report -Pintegration-tests -Pjavadoc
6060

6161
- name: Build, Analyse and Deploy with Maven
6262
if: github.ref == 'refs/heads/develop' && matrix.isMainBuildEnv
@@ -75,4 +75,4 @@ jobs:
7575
ACTOOL_IMS_IT_CLIENTSECRET: ${{ secrets.ACTOOL_IMS_IT_CLIENTSECRET }}
7676
ACTOOL_IMS_IT_PRODUCTPROFILE: ${{ vars.ACTOOL_IMS_IT_PRODUCTPROFILE }}
7777
ACTOOL_IMS_IT_USERID: ${{ vars.ACTOOL_IMS_IT_USERID }}
78-
run: mvn -e -B -V clean deploy org.sonarsource.scanner.maven:sonar-maven-plugin:sonar -Dsonar.projectKey=Netcentric_accesscontroltool -Dsonar.organization=netcentric -Dsonar.host.url=https://sonarcloud.io -DnvdApiKeyEnvironmentVariable=NVD_API_KEY -Pdependency-check,coverage-report,integration-tests
78+
run: mvn -e -B -V clean deploy org.sonarsource.scanner.maven:sonar-maven-plugin:sonar -Dsonar.projectKey=Netcentric_accesscontroltool -Dsonar.organization=netcentric -Dsonar.host.url=https://sonarcloud.io -DnvdApiKeyEnvironmentVariable=NVD_API_KEY -Pdependency-check -Pcoverage-report -Pintegration-tests -Pjavadoc

‎accesscontroltool-bundle/src/main/java/biz/netcentric/cq/tools/actool/api/AcInstallationService.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,11 @@ public interface AcInstallationService {
2525
* Applies the configuration asynchronously.
2626
* Almost immediately returns a string with the ID of the started job.
2727
* Only one execution at a time is allowed.
28-
* @param options
28+
* @param options the installation options which further specify the installation
2929
* @throws IllegalStateException if another asynchronous installation is currently running
3030
* @return the job id
3131
* @since 3.6.0
32-
* @see #attachLogListener(String, InstallationLogListener)
32+
* @see #attachLogListener(String, BiConsumer, Consumer)
3333
*/
3434
public String applyAsynchronously(InstallationOptions options);
3535

‎accesscontroltool-bundle/src/main/java/biz/netcentric/cq/tools/actool/api/InstallationOptionsBuilder.java‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
package biz.netcentric.cq.tools.actool.api;
22

3-
import java.io.Serializable;
4-
53
/*-
64
* #%L
75
* Access Control Tool Bundle
@@ -35,6 +33,7 @@ public final class InstallationOptionsBuilder {
3533

3634
/**
3735
* Creates a new builder with the given properties previously returned by {@link InstallationOptions#getPersistableProperties()}.
36+
* @param properties the properties returned by {@link InstallationOptions#getPersistableProperties()}
3837
*/
3938
public InstallationOptionsBuilder(Map<String, Object> properties) {
4039
this.configurationRootPath = (String)properties.get("configurationRootPath");

‎accesscontroltool-oakindex-package/pom.xml‎

Lines changed: 5 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -38,22 +38,12 @@
3838
<filterSource>src/main/META-INF/vault/filter.xml</filterSource>
3939
<allowIndexDefinitions>true</allowIndexDefinitions>
4040
<packageType>content</packageType><!-- regular mutable content for AEM Classic -->
41+
<validatorsSettings>
42+
<netcentric-aem-cloud>
43+
<isDisabled>true</isDisabled>
44+
</netcentric-aem-cloud>
45+
</validatorsSettings>
4146
</configuration>
42-
<executions>
43-
<execution>
44-
<id>default-validate-package</id>
45-
<goals>
46-
<goal>validate-package</goal>
47-
</goals>
48-
<configuration>
49-
<validatorsSettings>
50-
<netcentric-aem-cloud>
51-
<isDisabled>true</isDisabled>
52-
</netcentric-aem-cloud>
53-
</validatorsSettings>
54-
</configuration>
55-
</execution>
56-
</executions>
5747
</plugin>
5848

5949
<plugin>

‎pom.xml‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -562,6 +562,25 @@
562562
</build>
563563

564564
<profiles>
565+
<profile>
566+
<id>javadoc</id>
567+
<build>
568+
<plugins>
569+
<plugin>
570+
<groupId>org.apache.maven.plugins</groupId>
571+
<artifactId>maven-javadoc-plugin</artifactId>
572+
<executions>
573+
<execution>
574+
<id>attach-javadocs</id>
575+
<goals>
576+
<goal>jar</goal>
577+
</goals>
578+
</execution>
579+
</executions>
580+
</plugin>
581+
</plugins>
582+
</build>
583+
</profile>
565584
<profile>
566585
<id>release</id>
567586
<build>

0 commit comments

Comments
 (0)