summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 12 insertions, 12 deletions
diff --git a/README.md b/README.md
index a34e2f7..8dfd028 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
# GitLab License Management
-[![pipeline status](https://gitlab.com/gitlab-org/security-products/license-management/badges/master/pipeline.svg)](https://gitlab.com/gitlab-org/security-products/license-management/commits/master)
-[![coverage report](https://gitlab.com/gitlab-org/security-products/license-management/badges/master/coverage.svg)](https://gitlab.com/gitlab-org/security-products/license-management/commits/master)
+[![pipeline status](https://gitlab.com/gitlab-org/security-products/analyzers/license-finder/badges/master/pipeline.svg)](https://gitlab.com/gitlab-org/security-products/analyzers/license-finder/commits/master)
+[![coverage report](https://gitlab.com/gitlab-org/security-products/analyzers/license-finder/badges/master/coverage.svg)](https://gitlab.com/gitlab-org/security-products/analyzers/license-finder/commits/master)
GitLab tool for detecting licenses of the dependencies used by the provided source.
It is currently based on [License Finder][license_finder]
@@ -16,10 +16,10 @@ only, but this may change in the future.
docker run \
--volume "$PWD":/code \
--rm \
- registry.gitlab.com/gitlab-org/security-products/license-management:latest analyze /code
+ registry.gitlab.com/gitlab-org/security-products/analyzers/license-finder:latest analyze /code
```
-1. The results will be stored in the `gl-license-management-report.json` file in the application directory.
+1. The results will be stored in the `gl-license-scanning-report.json` file in the application directory.
## Development
@@ -34,7 +34,7 @@ $ ./bin/docker-build
You can then run License Management on some target directory:
```sh
-$ docker run --rm --volume "/path/to/my/project":/code license-management analyze /code
+$ docker run --rm --volume "/path/to/my/project":/code --env CI_PROJECT_DIR=/code
```
### Running the tests
@@ -58,7 +58,7 @@ $ enable_dev_mode
$ bundle open license_finder
```
-The `docker-shell` script will mount the current project as a volume into `/builds/gitlab-org/security-products/license-management`.
+The `docker-shell` script will mount the current project as a volume into `/builds/gitlab-org/security-products/analyzers/license-finder`.
This allows you to edit code from your host machine using your preferred editor and
see the affect of those changes from within the running docker container.
@@ -94,7 +94,7 @@ docker run \
--volume "$PWD":/code \
--env "SETUP_CMD=./my-custom-install-script.sh" \
--rm \
- registry.gitlab.com/gitlab-org/security-products/license-management:latest analyze /code
+ registry.gitlab.com/gitlab-org/security-products/analyzers/license-finder:latest analyze /code
```
## Settings
@@ -135,16 +135,16 @@ Please check the [Release Process documentation](https://gitlab.com/gitlab-org/s
If you want to help, read the [contribution guidelines](CONTRIBUTING.md).
If an unknown license is detected, please consider updating the mapping defined
-in [normalized-licenses.yml](https://gitlab.com/gitlab-org/security-products/license-management/blob/master/normalized-licenses.yml). A mapping can be for a detected name or url and must correspond to an SPDX identifier found in [spdx-licenses.json](https://gitlab.com/gitlab-org/security-products/license-management/blob/master/spdx-licenses.json).
+in [normalized-licenses.yml](https://gitlab.com/gitlab-org/security-products/analyzers/license-finder/blob/master/normalized-licenses.yml). A mapping can be for a detected name or url and must correspond to an SPDX identifier found in [spdx-licenses.json](https://gitlab.com/gitlab-org/security-products/analyzers/license-finder/blob/master/spdx-licenses.json).
[bower]: https://bower.io/
[bundler]: https://bundler.io/
-[changelog]: https://gitlab.com/gitlab-org/security-products/license-management/-/blob/master/CHANGELOG.md
+[changelog]: https://gitlab.com/gitlab-org/security-products/analyzers/license-finder/-/blob/master/CHANGELOG.md
[composer]: https://getcomposer.org
[conan]: https://conan.io/
[dotnet_core]: https://docs.microsoft.com/en-us/dotnet/core/tools/
-[gemfile_lock]: https://gitlab.com/gitlab-org/security-products/license-management/-/blob/master/Gemfile.lock
-[gemspec]: https://gitlab.com/gitlab-org/security-products/license-management/-/blob/master/license-management.gemspec
+[gemfile_lock]: https://gitlab.com/gitlab-org/security-products/analyzers/license-finder/-/blob/master/Gemfile.lock
+[gemspec]: https://gitlab.com/gitlab-org/security-products/analyzers/license-finder/-/blob/master/license-management.gemspec
[godep]: https://github.com/tools/godep
[gomod]: https://github.com/golang/go/wiki/Modules
[gradle]: https://gradle.org/
@@ -154,5 +154,5 @@ in [normalized-licenses.yml](https://gitlab.com/gitlab-org/security-products/lic
[nuget]: https://www.nuget.org/
[pip]: https://pip.pypa.io/en/stable/
[pipenv]: https://github.com/pypa/pipenv
-[version_rb]: https://gitlab.com/gitlab-org/security-products/license-management/-/blob/master/lib/license/management/version.rb
+[version_rb]: https://gitlab.com/gitlab-org/security-products/analyzers/license-finder/-/blob/master/lib/license/management/version.rb
[yarn]: https://yarnpkg.com/