From b83272b09bf001bf88a4b53ca9df9a0bac597148 Mon Sep 17 00:00:00 2001 From: Mustafa Kara Date: Tue, 7 Jun 2022 14:05:26 +0300 Subject: [PATCH] Apply changes from code review Signed-off-by: Mustafa Kara --- build/notice-file/Readme.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/build/notice-file/Readme.md b/build/notice-file/Readme.md index e69de29bb..de2e3818f 100644 --- a/build/notice-file/Readme.md +++ b/build/notice-file/Readme.md @@ -0,0 +1,34 @@ +# Notice.txt File Configuration + +We are automatically generating Notice.txt by using first-level dependencies of the project. The related pipeline uses `config.yaml` stored in this folder. + + +## Configuration + +Sample: + +``` +title: "Mattermost Mobile" +copyright: "© 2016-present Mattermost, Inc. All Rights Reserved. See LICENSE.txt for license information." +description: "This document includes a list of open source components used in Mattermost Mobile, including those that have been modified." +reviewers: + - mattermost/release-managers + - enahum +search: + - "package.json" +dependencies: + - "wix" +devDependencies: + - "webpack" +``` + +| Field | Type | Purpose | +| :-- | :-- | :-- | +| title | string | Field content will be used as a title of the application. See first line of `NOTICE.txt` file. | +| copyright | string | Field content will be used as a copyright message. See second line of `NOTICE.txt` file. | +| description | string | Field content will be used as notice file description. See third line of `NOTICE.txt` file. | +| reviewers | array of GitHub user/teams | Those will be automatically assigned to the PRs as reviewers. | +| dependencies | array | If any dependency name mentioned, it will be automatically added even if it is not a first-level dependency. | +| 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`. | +