Skip to content

Latest commit

 

History

History
92 lines (69 loc) · 4.78 KB

README.md

File metadata and controls

92 lines (69 loc) · 4.78 KB
Raw

Build Status codecov Codacy Badge Known Vulnerabilities GitHub top language CLA assistant GitHub

LicenseScout

LicenseScout is a Maven Plug-in to identify third-party artifacts (libraries) and their licenses, in Java as well as JavaScript projects. The goal is to get an overview over the used licenses, and the artifacts for which no license could be detected. A proper output document is generated listing the used licenses and the corresponding license texts. In a configuration file each license identified is marked as ACCEPTED or NOT_ACCEPTED. This decision depends on the your project's license and may require legal support.

Getting started

For detail information, see the full documentation.

Prerequisites

  • Maven 3 installation

Usage

Declare the Plugin and executions in the pom.xml:

<plugins>
    <plugin>
        <groupId>org.aposin.licensescout</groupId>
        <artifactId>licensescout-maven-plugin</artifactId>
        <version>1.1.4</version>
        <executions>
            <execution>
                <id>find-licenses</id>
                <phase>verify</phase>
                <goals>
                    <goal>scanJava</goal>
                </goals>
                <configuration>
                    <scanDirectory>${project.build.directory}/products/my.product/win32/win32/x86/plugins/</scanDirectory>
                    <outputDirectory>${licensescout.outputDirectory}</outputDirectory>
                    <outputs>
                        <output>
                            <type>TXT</type>
                            <filename>${licensescout.outputFilename.txt}</filename>
                            <url>${licensereport.url.txt}</url>
                        </output>
                    </outputs>
                    <licensesFilename>${licensescout-configuration.dir}/licenses.xml</licensesFilename>
                    <providersFilename>${licensescout-configuration.dir}/providers.xml</providersFilename>
                    <noticesFilename>${licensescout-configuration.dir}/notices.xml</noticesFilename>
                    <checkedArchivesFilename>${licensescout-configuration.dir}/checkedarchives.csv</checkedArchivesFilename>
                    <licenseUrlMappingsFilename>${licensescout-configuration.dir}/urlmappings.csv</licenseUrlMappingsFilename>
                    <licenseNameMappingsFilename>${licensescout-configuration.dir}/namemappings.csv</licenseNameMappingsFilename>
                    <globalFiltersFilename>${licensescout-configuration.dir}/globalfilters.csv</globalFiltersFilename>
                    <filteredVendorNamesFilename>${licensescout-configuration.dir}/filteredvendornames.csv</filteredVendorNamesFilename>
            </configuration>
            </execution>
        </executions>

    </plugin>
</plugin>

ℹ️ For further information about how to configure the Plugin, please see the full documentation.

As an example output, the NOTICE.txt in this repository is the result of LiceseScout running on itself.

Building

To build and run LicenseScout on itself in this repository:

cd org.aposin.licensescout.quickstart
mvn clean install

The reports are written to the directory org.aposin.licensescout.licensereport/target.

Contributing

Please read CODE_OF_CONDUCT.md for details on our code of conduct, and CONTRIBUTING.md for the process for submitting pull requests to us.

Authors

The authors list is maintained in the CONTRIBUTORS.txt file. See also the Contributors list at GitHub.

License

This project is under the Apache License 2.0 - see the LICENSE file for details.