commit	73682e5c5906e4597c451a3a79ff17808bc859da	[log] [tgz]
author	Konrad Windszus <kwin@apache.org>	Wed Jun 08 17:48:02 2022 +0200
committer	Konrad Windszus <kwin@apache.org>	Wed Jun 08 17:48:02 2022 +0200
tree	c67301c676e90283c657a6292b2507b2d823bc36
parent	1df309614b278156f6fbb386ea27e73920dd0b1f [diff]

tree: c67301c676e90283c657a6292b2507b2d823bc36

README.md

Apache Sling Maven Enforcer Rules

This module is part of the Apache Sling project.

It provides additional Maven Enforcer rules.

Rules

Require Provided Dependencies in Runtime Classpath

Checks that the runtime classpath (e.g. used by Maven Plugins via the Plugin Classloader or by the Appassembler Maven Plugin's assemble goal) contains all provided dependencies both direct and transitive ones.

As those are not transitively inherited they need to be declared explicitly in the pom.xml of the using Maven project.

Parameters

All parameters are optional.

excludes - a list of dependencies to skip. Their transitive dependencies are not evaluated either. The format is <groupId>[:<artifactId>[:<extension>[:<classifier>]]]. Wild cards (*) may be used to replace an entire part of a section. Examples:
- org.apache.maven (everything with the given group)
- org.apache.maven:myArtifact
- org.apache.maven:*:jar
includeOptionalDependencies - whether to include optional dependencies in the check. Either true or false. By default no optional dependencies are checked.
includeDirectDependencies - whether to include direct (provided) dependencies in the check. Either true or false. By default no direct provided dependencies are checked.

Sample Plugin Configuration:

<project>
  [...]
  <build>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-enforcer-plugin</artifactId>
        <version>3.0.0</version>
        <dependencies>
          <dependency>
            <groupId>org.apache.sling</groupId>
            <artifactId>maven-enforcer-rules</artifactId>
            <version>LATEST</version>
          </dependency>
        </dependencies>
        <executions>
          <execution>
            <id>enforce-complete-runtime-classpath</id>
            <goals>
              <goal>enforce</goal>
            </goals>
            <configuration>
              <rules>
                <requireProvidedDependenciesInRuntimeClasspath implementation="org.apache.sling.maven.enforcer.RequireProvidedDependenciesInRuntimeClasspath">
                  <excludes>
                    <exclude>javax.servlet:javax.servlet-api</exclude>
                  </excludes>
                </requireProvidedDependenciesInRuntimeClasspath>
              </rules>
              <fail>true</fail>
            </configuration>
          </execution>
        </executions>
      </plugin>
    </plugins>
  </build>
  [...]
</project>