@newrelic/newrelic-plugin-oss-third-party
v0.1.2
Published
os-third-party-license-generator ================================
Downloads
7,817
Readme
os-third-party-license-generator
Usage
$ npm install -g @newrelic/newrelic-plugin-oss-third-party
$ oclif-example COMMAND
running command...
$ oclif-example (-v|--version|version)
@newrelic/newrelic-plugin-oss-third-party/0.1.2 darwin-x64 node-v16.5.0
$ oclif-example --help [COMMAND]
USAGE
$ oclif-example COMMAND
...
Commands
oclif-example third-party FILE
Generate third party notices
Generate third party notices
(1) Make sure you have run "npm install" before using this tool. It depends on node_modules.
(2) Run with "manifest" to update the manifest file (third_party_manifest.json).
(3) Review the contents of third_party_manifest.json for accuracy and items marked "FOR_REVIEW" that require manual intervention.
(3a) Optionally add additional third party notices to a THIRD_PARTY_NOTICES_ADDENDUM.md file at the root of the project.
(4) Run with "notices" to update the notices file (THIRD_PARTY_NOTICES.md) using the manifest.
(5) Review the contents of THIRD_PARTY_NOTICES.md for accuracy.
(5a) Optionally add a footer to a THIRD_PARTY_NOTICES_FOOTER.md file at the root of the project.
(6) Commit and deploy your changes.
(7) Yay open source!
WARNING: this tool does not currently handle monorepos.
USAGE
$ oclif-example third-party FILE
ARGUMENTS
FILE (manifest|notices) What file do you want to update? Use "manifest" to update the third_party_manifest.json
manifest of third party dependencies. Use "notices" to update the THIRD_PARTY_NOTICES.md file using the content
of the manifest.
OPTIONS
--forceUpdate Force update of manifest file.
--includeOptDeps Include optional dependencies in manfiest
DESCRIPTION
(1) Make sure you have run "npm install" before using this tool. It depends on node_modules.
(2) Run with "manifest" to update the manifest file (third_party_manifest.json).
(3) Review the contents of third_party_manifest.json for accuracy and items marked "FOR_REVIEW" that require manual
intervention.
(3a) Optionally add additional third party notices to a THIRD_PARTY_NOTICES_ADDENDUM.md file at the root of the
project.
(4) Run with "notices" to update the notices file (THIRD_PARTY_NOTICES.md) using the manifest.
(5) Review the contents of THIRD_PARTY_NOTICES.md for accuracy.
(5a) Optionally add a footer to a THIRD_PARTY_NOTICES_FOOTER.md file at the root of the project.
(6) Commit and deploy your changes.
(7) Yay open source!
WARNING: this tool does not currently handle monorepos.
See code: src/commands/third-party.js