Licensed

Licensed is a Ruby gem to cache and verify the licenses of dependencies.

Installation

Add this line to your application's Gemfile:

gem 'licensed', :group => 'development'

And then execute:

$ bundle

Usage

• licensed cache: Cache licenses and metadata in vendor/licenses

• licensed verify: Check for issues with the licenses of dependencies. For example:

$ bundle exec licensed verify
Verifying licenses for 3 dependencies

Warnings:

vendor/licenses/rubygem/bundler.txt:
  - license needs reviewed: mit.

vendor/licenses/rubygem/licensee.txt:
  - missing license data

vendor/licenses/bower/jquery.txt:
  - license needs reviewed: mit.
  - cached license data out of date

3 dependencies checked, 3 warnings found.

Configuration

Configuration is managed by vendor/licenses/config.yml.

# Dependencies with these licenses are approved by default.
whitelist:
  - mit
  - apache-2.0
  - bsd-2-clause
  - bsd-3-clause
  - cc0-1.0

# These dependencies are explicitly ignored.
ignored:
  rubygem:
    - some-internal-gem

  bower:
    - some-internal-package

# These dependencies have been reviewed.
reviewed:
  rubygem:
    - bcrypt-ruby

  bower:
  - classlist # public domain
  - octicons

Sources

Dependencies from Bundler, NPM, and Bower will be automatically detected. You can disable any of them in vendor/licenses/config.yml:

sources:
  rubygem: false
  npm: false
  bower: false

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/github/licensed. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.