github-license-collector

README

GitHub License Collector

Install:

go install github.com/bitrise-io/github-license-collector

Usage:

You have to set a GitHub Personal Access Token (https://github.com/settings/tokens - generate one with the full repo scope), so that the tool can access private repos of the specified org:

export GITHUB_PERSONAL_ACCESS_TOKEN='..Personal Access Token..'

Now you can run the collect command to collect all the repos of a specified GitHub Organization and then collect the licenses for all of those repos:

go install && github-license-collector collect --org=GitHubOrgName | tee log.txt

Requirements

• Go: cd /tmp && go install -v github.com/google/go-licenses@master && cd -
• Node 10, brew install node@10
• Yarn, npm install -g yarn
• Get go packages, go get ./...
• tee if you want to use the tee command in the example

Analyzers

This tool will run all analyzers under the /analyzers directory.

Each analyzer has a Detect logic in which it can decide if the given repository source is matching for the type it is looking for. The detected phase's description can be found in each analyzer's readme.

Also all analyzer have an AnalyzeRepository logic which will try to fetch all the dependencies from the project and searches for its license type. They way it reads the list of dependencies is documented in the analyzers readme.

• NPM License Analyzer
• Go License Analyzer
• Ruby License Analyzer