Skip to content

Commit 51e6bdf

Browse files
committed
updated NOTICE.txt and configuration
1 parent cceb480 commit 51e6bdf

File tree

4 files changed

+2616
-0
lines changed

4 files changed

+2616
-0
lines changed

.config/notice-file/README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Notice.txt File Configuration
2+
3+
We are automatically generating Notice.txt by using first-level dependencies of the project. The related pipeline uses `config.yaml` stored in this folder.
4+
5+
6+
## Configuration
7+
8+
Sample:
9+
10+
```
11+
title: "Mattermost Playbooks"
12+
copyright: "©2015-present Mattermost, Inc. All Rights Reserved. See LICENSE for license information."
13+
description: "This document includes a list of open source components used in Mattermost Playbooks, including those that have been modified."
14+
search:
15+
- "go.mod"
16+
- "client/go.mod"
17+
dependencies: []
18+
devDependencies: []
19+
```
20+
21+
| Field | Type | Purpose |
22+
| :-- | :-- | :-- |
23+
| title | string | Field content will be used as a title of the application. See first line of `NOTICE.txt` file. |
24+
| copyright | string | Field content will be used as a copyright message. See second line of `NOTICE.txt` file. |
25+
| description | string | Field content will be used as notice file description. See third line of `NOTICE.txt` file. |
26+
| dependencies | array | If any dependency name mentioned, it will be automatically added even if it is not a first-level dependency. |
27+
| devDependencies | array | If any dependency name mentioned, it will be added when it is referenced in devDependency section. |
28+
| search | array | Pipeline will search for package.json/go.mod files mentioned here. Globstar format is supported ie. `x/**/go.mod`. |

.config/notice-file/config.yaml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
title: "Mattermost GitHub Plugin"
3+
copyright: "©2018-present Mattermost, Inc. All Rights Reserved. See LICENSE.txt for license information."
4+
description: "This document includes a list of open source components used in the plugin, including those that have been modified."
5+
search:
6+
- "go.mod"
7+
- "webapp/package.json"
8+
dependencies: []
9+
devDependencies: []

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,6 @@ server/plugin/manifest.go
1515

1616
# VS Code
1717
.vscode
18+
19+
# notice
20+
.notice-work

0 commit comments

Comments
 (0)