diff --git a/build/notice-file/Readme.md b/build/notice-file/Readme.md index de2e3818f..61a6a68dc 100644 --- a/build/notice-file/Readme.md +++ b/build/notice-file/Readme.md @@ -5,6 +5,16 @@ We are automatically generating Notice.txt by using first-level dependencies of ## Configuration +Notice.txt will be always generated from first level dependencies scanned from package.json files. For some cases it may be useful to define +dependency to add it's licence to the Notice.txt even if it is not first level dependency or development dependency. + +For instance at desktop project we need to add `wix`'s licence to the Notice.txt even if it is not a first level dependency. To do that define +all dependencies at `dependencies` array at the configuration. For any dependency at `dependencies` section, pipeline code will add their +licenses to the Notice.txt file. + +At webapp project `webpack` used in `devDependencies` and it is requested because we are using some files generated by `webpack`. If any dependency +referenced at `devDependencies` section, pipeline will add those dependency licences when they are referenced at `package.json` files. + Sample: ``` @@ -32,3 +42,4 @@ devDependencies: | devDependencies | array | If any dependency name mentioned, it will be added when it is referenced in devDependency section. | | search | array | Pipeline will search for package.json files mentioned here. Globstar format is supported ie. `packages/**/package.json`. | +