-
Notifications
You must be signed in to change notification settings - Fork 39
Open
Description
Detailed Description
Extend the export
command with additional parameters, with which the release notes could be exported at runtime in different formats.
Context
Using GitReleaseManager in a DevOps environment I would like to export the release notes as plain text, so I can use them for the creation of NuGet packages.
Possible Implementation
I suggest to add following optional parameters:
--format value
Defines the export format of the release notes.
Default format should be as current markdown.
The values for the--format
parameter could be:- Markdown:
md / markdown
- Text:
txt / text / raw
- I suggest to use the short values
md / txt
- At a not supported value a exception should be thrown
- Markdown:
--includeDateInTitle true/false
Defines if the date in the milestone title0.1.0 (01.07.2020)
is included or excluded.
Default is the value of the yaml configexport: include-created-date-in-title
property.--includeSubtitle true/false
Defines if the subtitleAs part of this release we had 1 issue closed.
is included or excluded.
Defaulttrue
.--includeLabels true/false
Defines if the issues are separated by labels.
Defaulttrue
.--includeIssueNumber true/false
Defines if the issue number is included or excluded.
Defaulttrue
.--includeFooter true/false
Defines if the footerWhere to get it
is included or excluded.
Default is the value of the yaml configcreate: include-footer
property.
I would like to implement the changes and provide a PR.