mattermost / notice-file-generator

Notice file generator for Go and Node projects.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

notice-file-generator

Notice file generator Mattermost tool to automatically generate NOTICE file for Go, Node and Python projects.

Get Involved

Developing

Environment Setup

Essentials:

  1. Install Go
  2. Configure Github Personal Access Token

Optionals:

  1. Configure config.yaml. Documentation is here.

Running

Execute go run with command line parameters:

go run ./... -c <CONFIG_FILE> -p <PATH_TO_PROJECT> -t <GITHUB_TOKEN>

Arguments:

Name Argument Description
Configuration File -c <path_to_config_file> Full path of the configuration file.
Project Path (optional) -p <project_path> Full path of the project's root directory. Current path will be used if not provided
Github Token (optional) -t <github_pat_token> Dependency licences will be fetched from Github, token needed to remove API rate limits.

Testing

Running all tests:

make test

License

See LICENSE.txt for license rights and limitations.

Release

Create a tag for desired version, pipelines will create and publish the release.

About

Notice file generator for Go and Node projects.

License:MIT License


Languages

Language:Go 60.3%Language:Makefile 37.3%Language:Dockerfile 2.5%