{"id":19865649,"url":"https://github.com/openfaas/license-check","last_synced_at":"2025-07-09T09:12:26.824Z","repository":{"id":44871163,"uuid":"109740002","full_name":"openfaas/license-check","owner":"openfaas","description":"Check your code for Copyright header compliance","archived":false,"fork":false,"pushed_at":"2023-03-16T13:10:17.000Z","size":45,"stargazers_count":21,"open_issues_count":0,"forks_count":9,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-06T23:06:10.556Z","etag":null,"topics":["community","compliance","continuous-integration","copyright","enterprise","legal","licensing","open-source","oss"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/openfaas.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-11-06T19:28:41.000Z","updated_at":"2024-07-28T04:38:35.000Z","dependencies_parsed_at":"2024-06-21T19:13:36.502Z","dependency_job_id":"aeb28973-40ea-4dba-a6af-9aaf7f978b3f","html_url":"https://github.com/openfaas/license-check","commit_stats":null,"previous_names":[],"tags_count":20,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openfaas%2Flicense-check","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openfaas%2Flicense-check/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openfaas%2Flicense-check/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openfaas%2Flicense-check/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openfaas","download_url":"https://codeload.github.com/openfaas/license-check/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251992938,"owners_count":21677022,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["community","compliance","continuous-integration","copyright","enterprise","legal","licensing","open-source","oss"],"created_at":"2024-11-12T15:23:35.683Z","updated_at":"2025-05-02T05:31:45.615Z","avatar_url":"https://github.com/openfaas.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"license-check\n==================\n\n[![build](https://github.com/openfaas/license-check/actions/workflows/build.yaml/badge.svg)](https://github.com/openfaas/license-check/actions/workflows/build.yaml)\n\nThis 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. \n\nThe tool is currently in use across the [OpenFaaS organisation](https://github.com/openfaas/) on GitHub.\n\n## Usage\n\n```\nUsage:\n\n$ license-check -root $HOME/go/src/github.com/openfaas \\\n    -verbose=false \"Alex Ellis\" \"OpenFaaS Author(s)\"\n```\n\nJust pass your license strings as arguments when running the tool.\n\n### Downloading with a multi-stage Dockerfile\n\nThis is the fastest method to download for use with Docker and includes multi-arch support.\n\nExample with Golang:\n\n```Dockerfile\nFROM ghcr.io/teamserverless/license-check:0.4.1 as license-check\nFROM golang:1.20 as build\n\nCOPY --from=license-check /license-check /usr/bin/\n\nRUN mkdir -p /go/src/github.com/openfaas/faas-netes\nWORKDIR /go/src/github.com/openfaas/faas-netes\nCOPY . .\n\nRUN license-check -path /go/src/github.com/openfaas/faas-netes/ --verbose=false \"Alex Ellis\" \"OpenFaaS Author(s)\"\n```\n\n### Downloading via curl\n\nThe following can be added to a Dockerfile to download the license-check binary:\n\n```Dockerfile\nRUN curl -sSfL https://github.com/openfaas/license-check/releases/download/0.2.3/license-check \\\n      \u003e /usr/bin/license-check \\\n      \u0026\u0026 chmod +x /usr/bin/license-check\n```\n\nIf you want to automatically download the correct binary for Linux/Darwin or armhf (Raspberry Pi) then use the `get.sh` script with the following:\n\n```Dockerfile\nRUN curl -sLSf https://raw.githubusercontent.com/openfaas/license-check/master/get.sh | sh\n```\n\n### Example usage\n\n```sh\nlicense-check -path ./ --verbose=false \"Alex Ellis\" \"OpenFaaS Project\" \"OpenFaaS Authors\" \"OpenFaaS Author(s)\"\n```\n\nThe following checks for the above valid strings in the current working path.\n\nExamples of usage in OpenFaaS:\n\n* https://github.com/openfaas/faas-cli/blob/master/Dockerfile\n* https://github.com/openfaas/faas/blob/master/gateway/Dockerfile\n\n## Contributing\n\nIf you'd like to submit a PR or request a feature, please raise an issue first.\n\nThen once the issue is cleared for working on, go ahead and raise a PR making sure to read the [CONTRIBUTING](./CONTRIBUTING.md) guide.\n\n### Development / hacking\n\nGo 1.19 or newer is required\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenfaas%2Flicense-check","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenfaas%2Flicense-check","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenfaas%2Flicense-check/lists"}