Skip to content

Commit

Permalink
Merge branch 'master' into xml-report
Browse files Browse the repository at this point in the history
  • Loading branch information
didierofrivia committed Oct 16, 2018
2 parents 301b513 + 9d40cba commit 2722bff
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 9 deletions.
25 changes: 19 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Build status
* Ruby 2.4.4 [![Ruby 2.4.4 build status](https://norsk.cf-app.com/api/v1/teams/main/pipelines/LicenseFinder/jobs/ruby-2.4.4/badge)](https://norsk.cf-app.com/teams/main/pipelines/LicenseFinder)
* Ruby 2.5.1 [![Ruby 2.5.1 build status](https://norsk.cf-app.com/api/v1/teams/main/pipelines/LicenseFinder/jobs/ruby-2.5.1/badge)](https://norsk.cf-app.com/teams/main/pipelines/LicenseFinder)
* JRuby 9.1.17.0 [![JRuby 9.1.17.0 build status](https://norsk.cf-app.com/api/v1/teams/main/pipelines/LicenseFinder/jobs/ruby-jruby-9.1.17.0/badge)](https://norsk.cf-app.com/teams/main/pipelines/LicenseFinder)
* JRuby 9.2.4.0 [![JRuby 9.2.0.0 build status](https://norsk.cf-app.com/api/v1/teams/main/pipelines/LicenseFinder/jobs/ruby-jruby-9.2.0.0/badge)](https://norsk.cf-app.com/teams/main/pipelines/LicenseFinder)
* JRuby 9.2.0.0 [![JRuby 9.2.0.0 build status](https://norsk.cf-app.com/api/v1/teams/main/pipelines/LicenseFinder/jobs/ruby-jruby-9.2.0.0/badge)](https://norsk.cf-app.com/teams/main/pipelines/LicenseFinder)


LicenseFinder works with your package managers to find dependencies,
Expand Down Expand Up @@ -117,6 +117,13 @@ dependencies, and where and how each license was discovered. This can
be useful when you need to track down an unexpected package or
license.

If you do not want to manually run an individual package manager's prepare
command (ex: `bundle install`, `npm install`, etc) to ensure your project
is fully prepared to be scanned, use the `--prepare` or `-p` option which will run
each active package manager's prepare command for you. If you would like to continue
running `license_finder` even if there is an issue with a prepare step, use the
`--prepare-no-fail` option which prepares but carries on despite any potential failures.

Run `license_finder help` to see other available commands, and
`license_finder help [COMMAND]` for detailed help on a specific
command.
Expand Down Expand Up @@ -163,11 +170,11 @@ languages, as long as that language has a package definition in the project dire
* `build.gradle` (for `gradle`)
* `settings.gradle` that specifies `rootProject.buildFileName` (for `gradle`)
* `bower.json` (for `bower`)
* `Podfile` (for CocoaPods)
* `Cartfile` (for Carthage)
* `Podfile` (for `pod`)
* `Cartfile` (for `carthage`)
* `rebar.config` (for `rebar`)
* `mix.exs` (for `mix`)
* `packages/` directory (for `Nuget`)
* `packages/` directory (for `nuget`)
* `vendor/manifest` or `*/vendor/manifest` file (for `gvt`)
* `glide.lock` file (for `glide`)
* `vendor/vendor.json` file (for `govendor`)
Expand Down Expand Up @@ -282,6 +289,12 @@ all of your project's dependencies and includes information about which need to
be approved. The project name at the top of the report can be set with
`license_finder project_name add`.

### Note:
When using the yarn package manager, when a node_module's package.json doesn't
explicitly declare a license, yarn indicates that it has inferred the license based
on some keywords in other files by appending an asterisk to the license name. If you
see a * at the end of the license name, this is intended.

See [CONTRIBUTING.md](https://github.com/pivotal-legacy/LicenseFinder/blob/master/CONTRIBUTING.md#adding-reports)
for advice about adding and customizing reports.

Expand Down Expand Up @@ -430,7 +443,7 @@ licenseConfigurations := Set("compile", "provided")

## Requirements

`license_finder` requires ruby >= 1.9, or jruby.
`license_finder` requires ruby >= 1.9.3, or jruby.


## Upgrading
Expand Down Expand Up @@ -466,7 +479,7 @@ And save a `LICENSE` file which contains your license text in your repo.
* Yarn
* A module that is incompatible with the platform on which
license_finder is run will always be reported to have a license type
of "unknown". (#456)
of "unknown". ([#456](https://github.com/pivotal-legacy/LicenseFinder/issues/456))

## Support

Expand Down
2 changes: 1 addition & 1 deletion lib/license_finder/package_managers/go_modules.rb
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ def takes_priority_over
end

def prepare_command
'go mod vendor'
'GOMOD111MODULE=on go mod vendor'
end
end

Expand Down
2 changes: 1 addition & 1 deletion lib/license_finder/version.rb
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# frozen_string_literal: true

module LicenseFinder
VERSION = '5.5.0'
VERSION = '5.5.1'
end
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ module LicenseFinder

describe '.prepare_command' do
it 'returns the correct package management command' do
expect(described_class.prepare_command).to eq('go mod vendor')
expect(described_class.prepare_command).to eq('GOMOD111MODULE=on go mod vendor')
end
end

Expand Down

0 comments on commit 2722bff

Please sign in to comment.