Skip to content

Enable Javadoc in GHA #809

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kwin merged 1 commit into from
Apr 12, 2025
Merged

Enable Javadoc in GHA #809

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .github/workflows/maven.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ jobs:

- name: Build with Maven
if: '!matrix.isMainBuildEnv'
run: mvn -e -B -V -Pintegration-tests clean verify
run: mvn -e -B -V clean verify -Pintegration-tests -Pjavadoc
- name: Build and Analyse with Maven
if: github.ref != 'refs/heads/develop' && matrix.isMainBuildEnv
env:
Expand All @@ -56,7 +56,7 @@ jobs:
ACTOOL_IMS_IT_CLIENTSECRET: ${{ secrets.ACTOOL_IMS_IT_CLIENTSECRET }}
ACTOOL_IMS_IT_PRODUCTPROFILE: ${{ vars.ACTOOL_IMS_IT_PRODUCTPROFILE }}
ACTOOL_IMS_IT_USERID: ${{ vars.ACTOOL_IMS_IT_USERID }}
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
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

- name: Build, Analyse and Deploy with Maven
if: github.ref == 'refs/heads/develop' && matrix.isMainBuildEnv
Expand All @@ -75,4 +75,4 @@ jobs:
ACTOOL_IMS_IT_CLIENTSECRET: ${{ secrets.ACTOOL_IMS_IT_CLIENTSECRET }}
ACTOOL_IMS_IT_PRODUCTPROFILE: ${{ vars.ACTOOL_IMS_IT_PRODUCTPROFILE }}
ACTOOL_IMS_IT_USERID: ${{ vars.ACTOOL_IMS_IT_USERID }}
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
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
4 changes: 2 additions & 2 deletions ...oltool-bundle/src/main/java/biz/netcentric/cq/tools/actool/api/AcInstallationService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,11 @@ public interface AcInstallationService {
* Applies the configuration asynchronously.
* Almost immediately returns a string with the ID of the started job.
* Only one execution at a time is allowed.
* @param options
* @param options the installation options which further specify the installation
* @throws IllegalStateException if another asynchronous installation is currently running
* @return the job id
* @since 3.6.0
* @see #attachLogListener(String, InstallationLogListener)
* @see #attachLogListener(String, BiConsumer, Consumer)
*/
public String applyAsynchronously(InstallationOptions options);

Expand Down
3 changes: 1 addition & 2 deletions ...l-bundle/src/main/java/biz/netcentric/cq/tools/actool/api/InstallationOptionsBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
package biz.netcentric.cq.tools.actool.api;

import java.io.Serializable;

/*-
* #%L
* Access Control Tool Bundle
Expand Down Expand Up @@ -35,6 +33,7 @@ public final class InstallationOptionsBuilder {

/**
* Creates a new builder with the given properties previously returned by {@link InstallationOptions#getPersistableProperties()}.
* @param properties the properties returned by {@link InstallationOptions#getPersistableProperties()}
*/
public InstallationOptionsBuilder(Map<String, Object> properties) {
this.configurationRootPath = (String)properties.get("configurationRootPath");
Expand Down
20 changes: 5 additions & 15 deletions accesscontroltool-oakindex-package/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,22 +38,12 @@
<filterSource>src/main/META-INF/vault/filter.xml</filterSource>
<allowIndexDefinitions>true</allowIndexDefinitions>
<packageType>content</packageType><!-- regular mutable content for AEM Classic -->
<validatorsSettings>
<netcentric-aem-cloud>
<isDisabled>true</isDisabled>
</netcentric-aem-cloud>
</validatorsSettings>
</configuration>
<executions>
<execution>
<id>default-validate-package</id>
<goals>
<goal>validate-package</goal>
</goals>
<configuration>
<validatorsSettings>
<netcentric-aem-cloud>
<isDisabled>true</isDisabled>
</netcentric-aem-cloud>
</validatorsSettings>
</configuration>
</execution>
</executions>
</plugin>

<plugin>
Expand Down
19 changes: 19 additions & 0 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -562,6 +562,25 @@
</build>

<profiles>
<profile>
<id>javadoc</id>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<executions>
<execution>
<id>attach-javadocs</id>
<goals>
<goal>jar</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
</profile>
<profile>
<id>release</id>
<build>
Expand Down