Skip to content

Clean up residual module-info.class before compilation #97

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
ppkarwasz merged 3 commits into from
Jan 11, 2024
Merged

Clean up residual module-info.class before compilation #97

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
604fbd6
Ban wildcard imports
ppkarwasz Jan 10, 2024
07b8196
Add `jspecify` to dependency management
ppkarwasz Jan 10, 2024
53d2fd6
Clean up residual `module-info.class` before compilation
ppkarwasz Jan 10, 2024
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
70 changes: 68 additions & 2 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -282,6 +282,7 @@
<org.eclipse.jgit.version>6.8.0.202311291450-r</org.eclipse.jgit.version>
<!-- These are annotation with a retention of CLASS. They can be freely upgraded. -->
<bnd.annotation.version>7.0.0</bnd.annotation.version>
<jspecify.version>0.3.0</jspecify.version>
<osgi.annotation.version>8.1.0</osgi.annotation.version>
<osgi.annotation.bundle.version>2.0.0</osgi.annotation.bundle.version>
<osgi.annotation.versioning.version>1.1.2</osgi.annotation.versioning.version>
Expand All @@ -298,6 +299,7 @@
<flatten-maven-plugin.version>1.5.0</flatten-maven-plugin.version>
<log4j-changelog-maven-plugin.version>0.7.0</log4j-changelog-maven-plugin.version>
<maven-artifact-plugin.version>3.5.0</maven-artifact-plugin.version>
<restrict-imports-enforcer-rule.version>2.4.0</restrict-imports-enforcer-rule.version>
<sign-maven-plugin.version>1.0.1</sign-maven-plugin.version>
<spotbugs-maven-plugin.version>4.8.2.0</spotbugs-maven-plugin.version>
<spotless-maven-plugin.version>2.41.1</spotless-maven-plugin.version>
Expand All @@ -324,6 +326,12 @@
<version>${spotbugs-annotations.version}</version>
</dependency>

<dependency>
<groupId>org.jspecify</groupId>
<artifactId>jspecify</artifactId>
<version>${jspecify.version}</version>
</dependency>

<dependency>
<groupId>org.osgi</groupId>
<artifactId>osgi.annotation</artifactId>
Expand Down Expand Up @@ -506,6 +514,36 @@
</executions>
</plugin>

<!--
~ Removes a trailing `module-info.class` before each compilation to prevent `javac` failures.
~
~ See https://github.com/copernik-eu/bug-reproducibility/tree/main/javac-module-info-bug
-->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-clean-plugin</artifactId>
<executions>
<execution>
<id>delete-module-descriptor</id>
<goals>
<goal>clean</goal>
</goals>
<phase>process-resources</phase>
<configuration>
<excludeDefaultDirectories>true</excludeDefaultDirectories>
<filesets>
<fileset>
<directory>${project.build.outputDirectory}</directory>
<includes>
<include>module-info.class</include>
</includes>
</fileset>
</filesets>
</configuration>
</execution>
</executions>
</plugin>

<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
Expand Down Expand Up @@ -644,12 +682,22 @@ import org.apache.commons.codec.digest.*;
</executions>
</plugin>

<!-- Ensure that version for each dependency resolved during a build, is equal to or higher than all transitive dependency declarations.
A failure here requires adding the dependency to the dependency management. -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-enforcer-plugin</artifactId>
<dependencies>
<dependency>
<groupId>de.skuzzle.enforcer</groupId>
<artifactId>restrict-imports-enforcer-rule</artifactId>
<version>${restrict-imports-enforcer-rule.version}</version>
</dependency>
</dependencies>
<executions>
<!--
~ Ensure that version for each dependency resolved during a build, is equal to or
~ higher than all transitive dependency declarations.
~ A failure here requires adding the dependency to the dependency management.
-->
<execution>
<id>enforce-upper-bound-deps</id>
<goals>
Expand All @@ -661,6 +709,24 @@ import org.apache.commons.codec.digest.*;
</rules>
</configuration>
</execution>
<!--
~ Ensures that no wildcard imports are used.
~ Wildcard imports increase the differences between branches and can not be expanded through simple tools.
-->
<execution>
<id>ban-wildcard-imports</id>
<goals>
<goal>enforce</goal>
</goals>
<configuration>
<rules>
<RestrictImports>
<reason>Expand all wildcard imports</reason>
<bannedImport>**.'*'</bannedImport>
</RestrictImports>
</rules>
</configuration>
</execution>
</executions>
</plugin>

Expand Down
8 changes: 8 additions & 0 deletions src/changelog/.10.x.x/add_jspecify.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<entry xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://logging.apache.org/log4j/changelog"
xsi:schemaLocation="http://logging.apache.org/log4j/changelog https://logging.apache.org/log4j/changelog-0.1.3.xsd"
type="added">
<issue id="88" link="https://github.com/apache/logging-parent/pull/88"/>
<description format="asciidoc">Add JSpecify to dependency management.</description>
</entry>
9 changes: 9 additions & 0 deletions src/changelog/.10.x.x/ban_wildcard_imports.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<?xml version="1.0" encoding="UTF-8"?>
<entry xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://logging.apache.org/log4j/changelog"
xsi:schemaLocation="http://logging.apache.org/log4j/changelog https://logging.apache.org/log4j/changelog-0.1.3.xsd"
type="added">
<issue id="63" link="https://github.com/apache/logging-parent/pull/63"/>
<description format="asciidoc">Add enforcer rule to ban wildcard imports.
All imports must be expanded to provide better comparison of branches.</description>
</entry>
8 changes: 8 additions & 0 deletions src/changelog/.10.x.x/remove-module-info-pre-compile.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<entry xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://logging.apache.org/log4j/changelog"
xsi:schemaLocation="http://logging.apache.org/log4j/changelog https://logging.apache.org/log4j/changelog-0.1.3.xsd"
type="changed">
<issue id="90" link="https://github.com/apache/logging-parent/pull/90"/>
<description format="asciidoc">Clean up residual `module-info.class` before compilation.</description>
</entry>