Skip to content

Commit

Permalink
updated NOTICE.txt and configuration
Browse files Browse the repository at this point in the history
  • Loading branch information
lieut-data committed Jan 27, 2025
1 parent 6c72240 commit f13d253
Show file tree
Hide file tree
Showing 3 changed files with 40 additions and 0 deletions.
28 changes: 28 additions & 0 deletions .config/notice-file/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# 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 Playbooks"
copyright: "©2015-present Mattermost, Inc. All Rights Reserved. See LICENSE for license information."
description: "This document includes a list of open source components used in Mattermost Playbooks, including those that have been modified."
search:
- "go.mod"
- "client/go.mod"
dependencies: []
devDependencies: []
```

| 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. |
| 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/go.mod files mentioned here. Globstar format is supported ie. `x/**/go.mod`. |
9 changes: 9 additions & 0 deletions .config/notice-file/config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: "Mattermost Microsoft Calendar Plugin"
copyright: "©2019-present Mattermost, Inc. All Rights Reserved. See LICENSE.txt for license information."
description: "This document includes a list of open source components used in the plugin, including those that have been modified."
search:
- "go.mod"
- "webapp/package.json"
dependencies: []
devDependencies: []
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,6 @@ server/manifest.go
.DS_Store
.npminstall
.idea

# notice
.notice-work

0 comments on commit f13d253

Please sign in to comment.