Apply changes from code review

Signed-off-by: Mustafa Kara <mustafa.kara@mattermost.com>
This commit is contained in:
Mustafa Kara 2022-06-07 16:48:20 +03:00
parent 3c40a6db30
commit 10faa0f37d
No known key found for this signature in database
GPG key ID: 89E5671BE4B93206

View file

@ -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`. |