History

Mario Vitale f5abf2141a Support new notice-file-generator version (#3046 )		2024-05-30 13:47:08 +02:00
..
config.yaml	Support new notice-file-generator version (#3046 )	2024-05-30 13:47:08 +02:00
Readme.md	Create configuration folder for notice.txt generation (#2149 )	2022-06-14 10:15:40 +03:00

Readme.md

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 Desktop"
copyright: "© 2016-2017 Mattermost, Inc.  All Rights Reserved.  See LICENSE.txt for license information."
description: "This document includes a list of open source components used in Mattermost Desktop, including those that have been modified."
reviewers: 
  - mattermost/release-managers
  - mattermost/team-desktop
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`.