Skip to content

Generate dependency reports in CSV, NOTICE, POM format, and try to analyze dependent LICENSE information.

Notifications You must be signed in to change notification settings

coolbeevip/license-maven-plugin

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Generate Maven project dependency report

Apache License 2 Maven Central OpenSSF Scorecard

Goals Overview

Generate dependency reports in CSV, NOTICE, POM format, and try to analyze dependent LICENSE information.

  • CSV Report

  • TXT Report

Usage

You generate dependency reports in the project directory. like this:

Note: If your project is a multi-module maven project, please use the mvn install command to install the artifacts to the local repos.

mvn io.github.coolbeevip:license-maven-plugin:1.16.0:dependency-license-export

Note: By default, NOTICE.CSV report is generated under the target/distribute

Optional Parameters

Name Type Since Description
format String 1.3.0 Report format: csv txt pom, Default value is: csv
ignoreGroupIds String 1.3.0 Ignore artifact groupId, multiple commas separated, for example: org.my.project,org.your.project
timeout Integer 1.3.0 Analysis timeout, Default value is: 60
deep Integer 1.4.0 Indirect Dependency Analysis Depth, Default value is: 100
license Boolean 1.3.0 Try to crawl https://search.maven.org/artifact/ data to get License information, Default value is: false. You should download and install ChromeDriver manually to ensure it matches your local Chrome browser version. It will try to crawl https://search.maven.org/artifact/ data to obtain License information. Please be sure to use it with caution.

Examples

  • Generate a dependency report in TXT format
    mvn io.github.coolbeevip:license-maven-plugin:1.16.0:dependency-license-export -Dformat=txt
  • Ignore artifacts for groupId org.my
    mvn io.github.coolbeevip:license-maven-plugin:1.16.0:dependency-license-export -DignoreGroupIds=org.my
  • Only analyze 10 layers of deep dependencies
    mvn io.github.coolbeevip:license-maven-plugin:1.16.0:dependency-license-export -Ddeep=10
  • Generate a report to try to get License information
    mvn io.github.coolbeevip:license-maven-plugin:1.16.0:dependency-license-export -Dlicense=true
  • Set analysis timeout 120 sec
    mvn io.github.coolbeevip:license-maven-plugin:1.16.0:dependency-license-export -Dtimeout=120

About

Generate dependency reports in CSV, NOTICE, POM format, and try to analyze dependent LICENSE information.

Resources

Stars

Watchers

Forks

Sponsor this project

 

Packages

No packages published