diff options
| author | mo khan <mo.khan@gmail.com> | 2020-04-22 01:57:13 +0000 |
|---|---|---|
| committer | mo khan <mo.khan@gmail.com> | 2020-04-22 01:57:13 +0000 |
| commit | d65dd61597375bfd6e6953fd4d0990a836fc3503 (patch) | |
| tree | f3350c1609075b4f877ed2bb8d931079816c8623 | |
| parent | 69b32c8d0ab7d6a635c2b1ec5b69e9ddb7786acf (diff) | |
| parent | 127be27879396792cdfce563976fd6dc075b387c (diff) | |
Merge branch 'cleanup-upstream-update-instructions' into 'master'
Cleanup upstream update instructions
See merge request gitlab-org/security-products/license-management!138
| -rw-r--r-- | README.md | 23 |
1 files changed, 2 insertions, 21 deletions
@@ -147,34 +147,15 @@ Please check the [Release Process documentation](https://gitlab.com/gitlab-org/s ## Upgrading to the latest version of LicenseFinder -The License Management projects depends on two different upstream components. - -1. The [LicenseFinder](https://rubygems.org/gems/license_finder) Ruby gem. -2. The [LicenseFinder](https://hub.docker.com/r/licensefinder/license_finder) Docker image. - -Upgrading each can be performed as two separate changes and do not need to occur simultaneously, -unless a new package manager has been added and additional tooling needs to be installed. - -### Upgrading the Ruby gem - 1. Check for the latest version of `LicenseFinder` at [https://rubygems.org/gems/license_finder](https://rubygems.org/gems/license_finder) -1. Check the version of the `license_finder` gem that is currently being used in the `Gemfile.lock`. E.g. [here](https://gitlab.com/gitlab-org/security-products/license-management/-/blob/39afdc40296871d9f7c1732ff3f7e1e3b7b28bbe/Gemfile.lock#L15) +1. Check the version of the `license_finder` gem that is currently being used in the [`Gemfile.lock`](https://gitlab.com/gitlab-org/security-products/license-management/-/blob/master/Gemfile.lock) 1. If an update is available, create a new 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. 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. Update the `license_finder` version constraint in the [gemspec](https://gitlab.com/gitlab-org/security-products/license-management/-/blob/master/license-management.gemspec). 1. Run `bundle update license_finder` 1. Test the changes locally using the `bin/test` script. 1. Submit a merge request. -### Upgrading the Docker image - -1. Check for the latest version of `LicenseFinder` at [https://hub.docker.com/r/licensefinder/license_finder/tags](https://hub.docker.com/r/licensefinder/license_finder/tags) -1. Check the version of `license_finder` docker image that is currently being used in the `Dockerfile`. E.g. [here](https://gitlab.com/gitlab-org/security-products/license-management/-/blob/39afdc40296871d9f7c1732ff3f7e1e3b7b28bbe/Dockerfile#L1) -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` script. -1. Submit a merge request. # Contributing |