-

name: 'Manual repo infos'

description: 'Run gren outside of the project folder.'

code: 'gren release --username=REPO_USER --repo=REPO_NAME'

-

name: 'Override an existing release'

description: 'By default, `gren` won''t override an existing release and it will flag `Skipping 4.0.0 (use --override to replace it)`. If you want to override, as it suggests, use:'

code: 'gren release --override'

-

name: 'Create release notes for a specific tag'

description: 'Create release notes from the commits or issues closed for the specified tag and the one before.'

code: 'gren release --tags=4.0.0'

-

description: 'Create release notes from the commits or the issues between two specified tags.'

code: 'gren release --tags=4.0.0..3.0.0'

-

name: 'Create release notes for all the tags'

description: 'Create release notes for all the tags in the repository.'

code: 'gren release --tags=all'

-

description: 'Ignore the tags including an Array of strings'

code: 'gren release --tags=all --ignore-tags-with="-rc","-alpha","-beta"'

-

name: 'Work with milestones'

description: 'Create release notes for a tag using the belonging to a milestone that matches the name of the tag. e.g. If the tag is 4.0.0, `gren` is going to match the milestone _"Release 4.0.0"_.'

code: 'gren release --data-source=milestones --milestone-match="Release {{tag_name}}"'

-

description: 'Otherwise, you can just filter the issues that belong to _a_ milestone'

code: 'gren release --only-milestones'

-

name: 'Use commit messages'

description: 'Generate release notes based on commit messages'

code: 'gren release --data-source=commits'