licence-checker

README

Go Logger

Description

Go License checker is an tool to check is packages have correct licenses

Prerequisite

this tool depends on github.com/google/go-licenses being installed

go install github.com/google/go-licenses@latest

Instalation

go install github.com/haproxytech/go-licence-checker@latest

Running

application expects .license-checker.yml file in same folder as go.mod file

location can also be specified with ENV variable LICENSE_CHECKER

Example

allowed:
    type:
        - Apache-2.0
        - MIT
        - BSD-2-Clause
        - BSD-3-Clause
        - ISC
blocked:
    type:
        - MPL-2.0 # this is not compatible with other allowed licenses

Full Example

allowed:
    type:
        - Apache-2.0
        - MIT
        - BSD-2-Clause
        - BSD-3-Clause
        - ISC
    packages:
        - package: github.com/group/package # with custom license
          licence: RND # type is needed since this can change over time
blocked:
    type: # this is not needed. all not listed in allowed are blocked
        - MPL-2.0 # this is not compatible with other allowed licenses
    packages:
        - github.com/group/package/ # with right license but not allowed

Contributing

Thanks for your interest in the project and your willing to contribute:

• this project uses taskfile
• Pull requests are welcome!
• For commit messages and general style please follow the haproxy project's CONTRIBUTING guide and use that where applicable.

Discussion

A Github issue is the right place to discuss feature requests, bug reports or any other subject that needs tracking.

To ask questions, get some help or even have a little chat, you can join our #ingress-controller channel in HAProxy Community Slack.

License

Apache License 2.0