Skip to content

Latest commit

 

History

History
78 lines (48 loc) · 2.38 KB

README.md

File metadata and controls

78 lines (48 loc) · 2.38 KB
Raw

license-check

build

This tool scans all files within a given path for copyright authors. It flags up any files which have authors not specified in a list of given strings.

The tool is currently in use across the OpenFaaS organisation on GitHub.

Usage

Usage:

$ license-check -root $HOME/go/src/github.com/openfaas \
    -verbose=false "Alex Ellis" "OpenFaaS Author(s)"

Just pass your license strings as arguments when running the tool.

Downloading with a multi-stage Dockerfile

This is the fastest method to download for use with Docker and includes multi-arch support.

Example with Golang:

FROM ghcr.io/teamserverless/license-check:0.4.1 as license-check
FROM golang:1.20 as build

COPY --from=license-check /license-check /usr/bin/

RUN mkdir -p /go/src/github.com/openfaas/faas-netes
WORKDIR /go/src/github.com/openfaas/faas-netes
COPY . .

RUN license-check -path /go/src/github.com/openfaas/faas-netes/ --verbose=false "Alex Ellis" "OpenFaaS Author(s)"

Downloading via curl

The following can be added to a Dockerfile to download the license-check binary:

RUN curl -sSfL https://github.com/openfaas/license-check/releases/download/0.2.3/license-check \
      > /usr/bin/license-check \
      && chmod +x /usr/bin/license-check

If you want to automatically download the correct binary for Linux/Darwin or armhf (Raspberry Pi) then use the get.sh script with the following:

RUN curl -sLSf https://raw.githubusercontent.com/openfaas/license-check/master/get.sh | sh

Example usage

license-check -path ./ --verbose=false "Alex Ellis" "OpenFaaS Project" "OpenFaaS Authors" "OpenFaaS Author(s)"

The following checks for the above valid strings in the current working path.

Examples of usage in OpenFaaS:

Contributing

If you'd like to submit a PR or request a feature, please raise an issue first.

Then once the issue is cleared for working on, go ahead and raise a PR making sure to read the CONTRIBUTING guide.

Development / hacking

Go 1.19 or newer is required