summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authormo khan <mo.khan@gmail.com>2020-03-04 12:12:48 -0700
committermo khan <mo.khan@gmail.com>2020-03-04 12:12:48 -0700
commitbcfd6f15f71129a504bab463e84f51e3b3840644 (patch)
tree1274e4547e14c8245ece2685deb4f754039aa19f /README.md
parent5957399681c8de847dbc062ca8d8e559fb38eb55 (diff)
Convert python qa jobs to integration tests
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 5 insertions, 17 deletions
diff --git a/README.md b/README.md
index b976fb7..8ae4865 100644
--- a/README.md
+++ b/README.md
@@ -19,7 +19,7 @@ only, but this may change in the future.
registry.gitlab.com/gitlab-org/security-products/license-management:latest analyze /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.
+1. The results will be stored in the `gl-license-management-report.json` file in the application directory.
## Development
@@ -38,24 +38,12 @@ You can then run License Management on some target directory:
docker run --rm --volume "/path/to/my/project":/code license-management analyze /code
```
-You can run the QA tests using the following command:
+You can run the tests using the following command:
```sh
-./bin/test-all
+./bin/test
```
-Or you can run a specific QA test using the following command:
-
-```sh
-QA_PROJECT=project_name QA_REF=git_ref ./bin/test
-```
-
-where:
-
-- `project_name` is the project slug among the
-[test projects for security products](https://gitlab.com/gitlab-org/security-products/tests/) (e.g. `java-maven`)
-- `git_ref` is the Git ref to checkout and scan against (e.g. `master`)
-
### Updating the SPDX index
We will need to periodically update the SPDX index. This can be achieved with
@@ -149,7 +137,7 @@ unless a new package manager has been added and additional tooling needs to be i
1. Bump the license management version in [CHANGELOG.md](https://gitlab.com/gitlab-org/security-products/license-management/-/blob/master/CHANGELOG.md) and in [version.rb](https://gitlab.com/gitlab-org/security-products/license-management/-/blob/master/lib/license/management/version.rb)
1. Update the `license_finder` version constraint in the [gemspec](https://gitlab.com/gitlab-org/security-products/license-management/-/blob/39afdc40296871d9f7c1732ff3f7e1e3b7b28bbe/license-management.gemspec#L30).
1. Run `bundle update license_finder`
-1. Test the changes locally using the `bin/test-all` script.
+1. Test the changes locally using the `bin/test` script.
1. Submit a merge request.
### Upgrading the Docker image
@@ -159,7 +147,7 @@ unless a new package manager has been added and additional tooling needs to be i
1. If an update is available, create a branch
1. Bump the license management version in [CHANGELOG.md](https://gitlab.com/gitlab-org/security-products/license-management/-/blob/master/CHANGELOG.md) and in [version.rb](https://gitlab.com/gitlab-org/security-products/license-management/-/blob/master/lib/license/management/version.rb)
1. Edit the version specified in the `DockerFile` to match the desired `license_finder` Docker image tag.
-1. Test the changes locally using the `bin/test-all` script.
+1. Test the changes locally using the `bin/test` script.
1. Submit a merge request.
# Contributing