49 lines
2.9 KiB
Markdown
49 lines
2.9 KiB
Markdown
# GitLab Licensing and Compatibility
|
|
|
|
[GitLab Community Edition](https://gitlab.com/gitlab-org/gitlab-foss/) (CE) is licensed [under the terms of the MIT License](https://gitlab.com/gitlab-org/gitlab-foss/blob/master/LICENSE). [GitLab Enterprise Edition](https://gitlab.com/gitlab-org/gitlab/) (EE) is licensed under "[The GitLab Enterprise Edition (EE) license](https://gitlab.com/gitlab-org/gitlab/blob/master/LICENSE)" wherein there are more restrictions.
|
|
|
|
## Automated Testing
|
|
|
|
In order to comply with the terms the libraries we use are licensed under, we have to make sure to check new gems for compatible licenses whenever they're added. To automate this process, we use the [license_finder](https://github.com/pivotal/LicenseFinder) gem by Pivotal. It runs every time a new commit is pushed and verifies that all gems and node modules in the bundle use a license that doesn't conflict with the licensing of either GitLab Community Edition or GitLab Enterprise Edition.
|
|
|
|
There are some limitations with the automated testing, however. CSS, JavaScript, or Ruby libraries which are not included by way of Bundler, NPM, or Yarn (for instance those manually copied into our source tree in the `vendor` directory), must be verified manually and independently. Take care whenever one such library is used, as automated tests won't catch problematic licenses from them.
|
|
|
|
Some gems may not include their license information in their `gemspec` file, and some node modules may not include their license information in their `package.json` file. These won't be detected by License Finder, and will have to be verified manually.
|
|
|
|
### License Finder commands
|
|
|
|
> Note: License Finder currently uses GitLab misused terms of `whitelist` and `blacklist`. As a result, the commands below reference those terms. We've created an [issue on their project](https://github.com/pivotal/LicenseFinder/issues/745) to propose that they rename their commands.
|
|
|
|
There are a few basic commands License Finder provides that you'll need in order to manage license detection.
|
|
|
|
To verify that the checks are passing, and/or to see what dependencies are causing the checks to fail:
|
|
|
|
```shell
|
|
bundle exec license_finder
|
|
```
|
|
|
|
To allowlist a new license:
|
|
|
|
```shell
|
|
license_finder whitelist add MIT
|
|
```
|
|
|
|
To denylist a new license:
|
|
|
|
```shell
|
|
license_finder blacklist add Unlicense
|
|
```
|
|
|
|
To tell License Finder about a dependency's license if it isn't auto-detected:
|
|
|
|
```shell
|
|
license_finder licenses add my_unknown_dependency MIT
|
|
```
|
|
|
|
For all of the above, please include `--why "Reason"` and `--who "My Name"` so the `decisions.yml` file can keep track of when, why, and who approved of a dependency.
|
|
|
|
More detailed information on how the gem and its commands work is available in the [License Finder README](https://github.com/pivotal/LicenseFinder).
|
|
|
|
## Additional information
|
|
|
|
Please see the [Open Source](https://about.gitlab.com/handbook/engineering/open-source/#using-open-source-libraries) page for more information on licensing.
|