Comment on page

Find licenses in use in third-party dependencies

org.openrewrite.java.dependencies.DependencyLicenseCheck
Locates and reports on all licenses in use.
Recipe source
​GitHub, Issue Tracker, Maven Central​
groupId: org.openrewrite.recipe
artifactId: rewrite-java-dependencies
version: 1.2.0
Options
Type
Name
Description
String
scope
Match dependencies with the specified scope
Boolean
addMarkers
Optional. Report each license transitively used by a dependency in search results.
Data Tables (Only available on the Moderne platform)
License report
Contains a license report of third-party dependencies.
Column Name
Description
Group
The first part of a dependency coordinate com.google.guava:guava:VERSION.
Artifact
The second part of a dependency coordinate com.google.guava:guava:VERSION.
Version
The resolved version.
License name
The actual name of the license as written in the third-party dependency.
License type
The license in use, based on the category of license inferred from the name.
Usage
This recipe has required configuration parameters. Recipes with required configuration parameters cannot be activated directly. To activate this recipe you must create a new recipe which fills in the required parameters. In your rewrite.yml create a new recipe with a unique name. For example: com.yourorg.DependencyLicenseCheckExample. Here's how you can define and customize such a recipe within your rewrite.yml:
rewrite.yml
---
type: specs.openrewrite.org/v1beta/recipe
name: com.yourorg.DependencyLicenseCheckExample
displayName: Find licenses in use in third-party dependencies example
recipeList:
  - org.openrewrite.java.dependencies.DependencyLicenseCheck:
      scope: compile
      addMarkers: null
Now that com.yourorg.DependencyLicenseCheckExample has been defined activate it and take a dependency on org.openrewrite.recipe:rewrite-java-dependencies:1.2.0 in your build file:
Gradle
Maven
Moderne CLI
1.Add the following to your build.gradle file:
build.gradle
plugins {
    id("org.openrewrite.rewrite") version("6.5.6")
}
​
rewrite {
    activeRecipe("com.yourorg.DependencyLicenseCheckExample")
}
​
repositories {
    mavenCentral()
}
​
dependencies {
    rewrite("org.openrewrite.recipe:rewrite-java-dependencies:1.2.0")
}
2.Run gradle rewriteRun to run the recipe.
1.Add the following to your pom.xml file:
pom.xml
<project>
  <build>
    <plugins>
      <plugin>
        <groupId>org.openrewrite.maven</groupId>
        <artifactId>rewrite-maven-plugin</artifactId>
        <version>5.13.0</version>
        <configuration>
          <activeRecipes>
            <recipe>com.yourorg.DependencyLicenseCheckExample</recipe>
          </activeRecipes>
        </configuration>
        <dependencies>
          <dependency>
            <groupId>org.openrewrite.recipe</groupId>
            <artifactId>rewrite-java-dependencies</artifactId>
            <version>1.2.0</version>
          </dependency>
        </dependencies>
      </plugin>
    </plugins>
  </build>
</project>
2.Run mvn rewrite:run to run the recipe.
You will need to have configured the Moderne CLI on your machine before you can run the following command.
shell
mod run . --recipe DependencyLicenseCheck
See how this recipe works across multiple open-source repositories
​​
​​
The community edition of the Moderne platform enables you to easily run recipes across thousands of open-source repositories.
Please contact Moderne for more information about safely running the recipes on your own codebase in a private SaaS.

Type	Name	Description
`String`	scope	Match dependencies with the specified scope
`Boolean`	addMarkers	Optional. Report each license transitively used by a dependency in search results.

Column Name	Description
Group	The first part of a dependency coordinate `com.google.guava:guava:VERSION`.
Artifact	The second part of a dependency coordinate `com.google.guava:guava:VERSION`.
Version	The resolved version.
License name	The actual name of the license as written in the third-party dependency.
License type	The license in use, based on the category of license inferred from the name.

Find and fix vulnerable dependencies

Remove a Gradle or Maven dependency

Last modified 9d ago