Options

template

type: string
required: yes

The path to your template file.

prTypes

type: { "identifier": string, "title": string, "filter"?: (prType: PRType, commit: Commit) => boolean; }[]
required: yes

Define which pull request should be included in the release note and how to generate the title. filter is useful when you want to set a condition to include the pull request. prType and commit is the parameter of the filter function. They can be used to check the pull request type and commit message. Allow you to write your custom filter logic.

plugins

type: RelnoPlugin[] required: no

The plugins to be used in Relno.