-

short: '-u'

name: username

valueType: '<repo owner>'

description: 'The username of the repo e.g. github-tools'

-

short: '-r'

name: repo

valueType: '<repository name>'

description: 'The repository name e.g. github-release-notes'

-

short: '-T'

name: token

valueType: '<github token>'

description: 'The token generated with repo access'

-

short: '-a'

name: api-url

valueType: '<url>'

description: 'Override the GitHub API URL, allows gren to connect to a private GHE installation'

-

short: '-o'

name: override

description: 'Override the release notes if exist'

-

short: '-B'

name: debug

description: 'Run the command in debugging mode'

-

short: '-t'

name: tags

valueType: '<new-tag>..<old-tag>'

description: 'Write release notes for <new-tag> using data collected until <old-tag>. If only one tag is specified, will use data until the previous tag. To run gren for all the tags, use --tags=all'

-

short: '-D'

name: data-source

valueType: '<issues|commits|milestones|prs>'

description: 'The informations you want to use to build release notes. [issues]'

defaultValue: issues

-

short: '-N'

name: include-messages

valueType: '<merge|commits|all>'

description: 'Filter the messages added to the release notes. Only used when --data-source used is commits [commits]'

defaultValue: commits

-

short: '-i'

name: ignore-tags-with

valueType: '<string1>,<string2>'

description: 'Ignore tags that contain one of the specified strings.'

-

short: '-C'

name: ignore-commits-with

valueType: '<string1>,<string2>'

description: 'Ignore commits that contain one of the specified strings.'

-

short: '-p'

name: prefix

valueType: '<name prefix>'

description: 'Add a prefix to the tag version. e.g. ''v'''

-

short: '-g'

name: group-by

valueType: '<label>'

description: 'Group the issues using the labels as group headings. You can set custom headings for groups of labels from a configuration file.'

-

short: '-L'

name: ignore-labels

valueType: '<label1>,<label2>'

description: 'Ignore the specified labels.'

-

short: '-I'

name: ignore-issues-with

valueType: '<label1>,<label2>'

description: 'Ignore issues that contains one of the specified labels.'

-

short: '-M'

name: milestone-match

valueType: '<prefix>'

description: 'The title that the script needs to match to link the release to the milestone. e.g. v will match v0.1.0 [Release {{tag_name}}]'

defaultValue: 'Release {{tag_name}}'

-

short: '-m'

name: only-milestones

description: 'Add to the release bodies only the issues that have a milestone'

-

short: '-q'

name: quiet

description: 'Run command without console logs.'