license_finder_upgrade
license_finder_upgrade
helps upgrade license_finder
projects from version ~1.2 to 2.0.
Installation
- Make sure you've upgraded to the latest version of
license_finder
less than version 2.0. You can check this withgem list --local license_finder
. - Run
license_finder
at least once with this lower version oflicense_finder
. This will ensure that thelicense_finder
database is in a state whichlicense_finder_upgrade
understands. - Install with
gem install license_finder_upgrade
Usage
Run the command once, in your project directory:
$ license_finder_upgrade
There should be no output, but a new file should exist in your doc/
directory
(or whichever directory license_finder
typically stores files in) called
dependency_decisions.yml
. Your config/license_finder.yml
file may also be
changed, or if you no longer need it, removed.
Finalization
- Review
dependency_decisions.yml
for accuracy and completeness. See thelicense_finder
README for information about the format of the file. - Review
config/license_finder.yml
, if it still exists. Unused keys have been removed. - Delete
doc/dependencies.db
. It is not used bylicense_finder
version 2.0. - Delete all the other
doc/dependencies*
files, if you want. If you want to keep some textual reports, see thelicense_finder report
README docs.license_finder
2.0 will not automatically updates these reports, so if you expect them to change, you must learn to runlicense_finder report
. - Install
license_finder >= 2.0
. After installing, when you runlicense_finder
you should see the same list of action items you had before upgrading. - Store your changes in version control.
Contributing
- Fork it ( https://github.com/mainej/license_finder_upgrade/fork )
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create a new Pull Request