Notice File Action

Automatically generate a NOTICE file for your repository using GitHub's dependency graph and ClearlyDefined.

Why use this action?

TL;DR It's an easy way to comply with license terms.

Most open source software licenses require the license to be included in any derivative works. For example, the MIT license:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

Or the Apache License 2.0:

You must give any other recipients of the Work or Derivative Works a copy of this License

NOTICE files are an industry-standard way of providing the licenses downstream, and complying with the license terms. But creating NOTICE files can be difficult. This action automates the whole process for you.

Examples

Basic

name: Generate NOTICE file
uses: JamieMagee/notice-action@main

Advanced

name: Generate NOTICE file
uses: JamieMagee/notice-action@main
with:
  format: html

Inputs

format

The output format to use. Can be:

• html
• json
• markdown
• text

License

All packages in this repository are licensed under the MIT license.