Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/openfaas/license-check
Check your code for Copyright header compliance
https://github.com/openfaas/license-check
community compliance continuous-integration copyright enterprise legal licensing open-source oss
Last synced: about 2 months ago
JSON representation
Check your code for Copyright header compliance
- Host: GitHub
- URL: https://github.com/openfaas/license-check
- Owner: openfaas
- License: mit
- Created: 2017-11-06T19:28:41.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-03-16T13:10:17.000Z (almost 2 years ago)
- Last Synced: 2024-06-21T20:04:31.209Z (7 months ago)
- Topics: community, compliance, continuous-integration, copyright, enterprise, legal, licensing, open-source, oss
- Language: Go
- Homepage:
- Size: 43.9 KB
- Stars: 20
- Watchers: 4
- Forks: 9
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
license-check
==================
[](https://github.com/openfaas/license-check/actions/workflows/build.yaml)
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](https://github.com/openfaas/) 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:
```Dockerfile
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:
```Dockerfile
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:
```Dockerfile
RUN curl -sLSf https://raw.githubusercontent.com/openfaas/license-check/master/get.sh | sh
```
### Example usage
```sh
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:
* https://github.com/openfaas/faas-cli/blob/master/Dockerfile
* https://github.com/openfaas/faas/blob/master/gateway/Dockerfile
## 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](./CONTRIBUTING.md) guide.
### Development / hacking
Go 1.19 or newer is required