license_finder_upgrade

license_finder_upgrade helps upgrade license_finder projects from version ~1.2 to 2.0.

Installation

1. Make sure you've upgraded to the latest version of license_finder less than version 2.0. You can check this with gem list --local license_finder.
2. Run license_finder at least once with this lower version of license_finder. This will ensure that the license_finder database is in a state which license_finder_upgrade understands.
3. 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

1. Review dependency_decisions.yml for accuracy and completeness. See the license_finder README for information about the format of the file.
2. Review config/license_finder.yml, if it still exists. Unused keys have been removed.
3. Delete doc/dependencies.db. It is not used by license_finder version 2.0.
4. Delete all the other doc/dependencies* files, if you want. If you want to keep some textual reports, see the license_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 run license_finder report.
5. Install license_finder >= 2.0. After installing, when you run license_finder you should see the same list of action items you had before upgrading.
6. Store your changes in version control.

Contributing

1. Fork it ( https://github.com/mainej/license_finder_upgrade/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request