license-lint

command
v1.15.0-bzc-beta.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 20, 2022 License: Apache-2.0 Imports: 14 Imported by: 0

README

Istio License Linter

This tool is used to ensure that the dependencies of a repo have acceptable licenses. The tool can be used in three modes:

  1. Linting. This ensures all dependencies of the current repo have unrestricted or reciprocal licenses, producing an error if any modules have a restricted or unknown license:

    $ license-lint --config <config file>
    
  2. Report. Lists license information for all dependencies:

    $ license-lint --config <config file> --report
    
  3. CSV. Lists license information for all dependencies in CSV format:

    $ license-lint --config <config file> --report
    
  4. Dump. Shows all licenses for all dependencies:

    $ license-lint --config <config file> --dump
    
  5. Mirror. Generates a licenses directory enumerating all modules and their exact license files.

    $ license-lint --mirror
    

The configuration is specified in a YAML file with four stanzas:

unrestricted_licenses:
  - license name 1
  - license name 2
reciprocal_licenses:
  - license name 1
  - license name 2
restricted_licenses:
  - license name 1
  - license name 2
allowlisted_modules:
  - module name 1
  - module name 2

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL