Skip to content

fix: attach an empty javadoc for modules which are not intended to be consumed as libraries #882

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

Open
chirino wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: attach an empty javadoc for modules which are not intended to be consumed as libraries #882

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
1 change: 1 addition & 0 deletions build-time-compiler-cli/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,7 @@
<version>2.1.1</version>
<configuration>
<flags>-Xmx1G</flags>
<inputFile>${project.build.directory}/${project.build.finalName}.jar</inputFile>
<programFile>chicory-compiler</programFile>
<attachProgramFile>true</attachProgramFile>
</configuration>
Expand Down
4 changes: 4 additions & 0 deletions build-time-compiler-cli/src/main/javadoc/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Notice: Private API

This module contains the private API. It is not intended for public use and it's classes
are subject to change without notice.
1 change: 1 addition & 0 deletions cli/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,7 @@
<version>2.1.1</version>
<configuration>
<flags>-Xmx1G</flags>
<inputFile>${project.build.directory}/${project.build.finalName}.jar</inputFile>
Copy link
Copy Markdown
Collaborator

@andreaTP andreaTP Jun 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why this line is needed in the CLIs and not in the other modules?

Copy link
Copy Markdown
Collaborator Author

@chirino chirino Jun 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that's because our goal is attaching the -javadoc.jar before this one executes and then it's not sure which of the attached jar to used for execution.

<programFile>chicory</programFile>
<attachProgramFile>true</attachProgramFile>
</configuration>
Expand Down
4 changes: 4 additions & 0 deletions cli/src/main/javadoc/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Notice: Private API

This module contains the private API. It is not intended for public use and it's classes
are subject to change without notice.
4 changes: 4 additions & 0 deletions compiler-maven-plugin/src/main/javadoc/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Notice: Private API

This module contains the private API. It is not intended for public use and it's classes
are subject to change without notice.
107 changes: 85 additions & 22 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@
<maven-install-plugin.version>3.1.4</maven-install-plugin.version>
<maven-jar-plugin.version>3.4.2</maven-jar-plugin.version>
<maven-javadoc-plugin.version>3.11.2</maven-javadoc-plugin.version>
<maven-build-helper-maven-plugin>3.6.0</maven-build-helper-maven-plugin>
<maven-plugin-plugin.version>3.15.1</maven-plugin-plugin.version>
<maven-resources-plugin.version>3.3.1</maven-resources-plugin.version>
<maven-shade-plugin.version>3.6.0</maven-shade-plugin.version>
Expand Down Expand Up @@ -720,28 +721,6 @@
</executions>
</plugin>

<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>${maven-javadoc-plugin.version}</version>
<configuration>
<doclint>none</doclint>
<source>11</source>
</configuration>
<executions>
<execution>
<id>attach-javadocs</id>
<goals>
<goal>jar</goal>
</goals>
<configuration>
<doclint>all,-missing</doclint>
<release>${maven.compiler.release}</release>
</configuration>
</execution>
</executions>
</plugin>

<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-source-plugin</artifactId>
Expand Down Expand Up @@ -770,6 +749,90 @@
</build>

<profiles>

<profile>
<id>package-javadoc-readme</id>
<activation>
<file>
<exists>${project.basedir}/src/main/javadoc/README.md</exists>
</file>
</activation>
<build>
<plugins>

<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jar-plugin</artifactId>
<version>${maven-jar-plugin.version}</version>
<executions>
<execution>
<id>package-javadoc-readme</id>
<goals>
<goal>jar</goal>
</goals>
<phase>package</phase>
<configuration>
<classifier>javadoc</classifier>
<classesDirectory>${project.basedir}/src/main/javadoc</classesDirectory>
<includes>
<include>**/*</include>
</includes>
<archive>
<manifest>
<addDefaultImplementationEntries>true</addDefaultImplementationEntries>
</manifest>
</archive>
</configuration>
</execution>
</executions>
</plugin>

<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>${maven-javadoc-plugin.version}</version>
<configuration>
<skip>true</skip>
</configuration>
</plugin>
</plugins>
</build>
</profile>
<profile>
<id>package-standard-javadocs</id>
<activation>
<file>
<missing>${project.basedir}/src/main/javadoc/README.md</missing>
</file>
</activation>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>${maven-javadoc-plugin.version}</version>
<configuration>
<!--<doclint>none</doclint>-->
Copy link
Copy Markdown
Collaborator

@andreaTP andreaTP May 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

leftover?

<doclint>all,-missing</doclint>
<source>11</source>
<release>${maven.compiler.release}</release>
<sourceFileExcludes>
<sourceFileExclude>**/internal/**</sourceFileExclude>
</sourceFileExcludes>
</configuration>
<executions>
<execution>
<id>attach-javadocs</id>
<goals>
<goal>jar</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
</profile>

<profile>
<!-- Disable strict checks during development -->
<id>dev</id>
Expand Down
Loading