diff options
| -rw-r--r-- | CHANGELOG.md | 4 | ||||
| -rw-r--r-- | CONTRIBUTING.md | 15 | ||||
| -rw-r--r-- | LICENSE | 7 | ||||
| -rw-r--r-- | README.md | 24 | ||||
| -rw-r--r-- | VERSION | 1 |
5 files changed, 51 insertions, 0 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..6e58915 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,4 @@ +# GitLab License management changelog + +## 11-0-stable +- Initial release diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..62b0e20 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,15 @@ +## Developer Certificate of Origin + License + +By contributing to GitLab B.V., You accept and agree to the following terms and +conditions for Your present and future Contributions submitted to GitLab B.V. +Except for the license granted herein to GitLab B.V. and recipients of software +distributed by GitLab B.V., You reserve all right, title, and interest in and to +Your Contributions. All Contributions are subject to the following DCO + License +terms. + +[DCO + License](https://gitlab.com/gitlab-org/dco/blob/master/README.md) + +_This notice should stay as the first item in the CONTRIBUTING.md file._ + +--- + @@ -0,0 +1,7 @@ +Copyright GitLab B.V. + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..5930586 --- /dev/null +++ b/README.md @@ -0,0 +1,24 @@ +# GitLab License Management + +[](https://gitlab.com/gitlab-org/security-products/license_management/commits/master) +[](https://gitlab.com/gitlab-org/security-products/license_management/commits/master) + +GitLab tool for detecting licenses of the dependencies used by the provided source. +It is currently based on License Finder only, but this may change in the future. + +## How to use + +1. `cd` into the directory of the source code you want to scan +1. Run the Docker image: + + ```sh + docker run \ + --volume "$PWD":/code \ + registry.gitlab.com/gitlab-org/security-products/license_management:latest /code + ``` + +1. The results will be stored in the `gl-license-management-report.json` file in the application directory. `gl-license-management-report.html` is also available with a human readable report. + +# Contributing + +If you want to help, read the [contribution guidelines](CONTRIBUTING.md). @@ -0,0 +1 @@ +11.0 |