Skip to content

Extend the export command to export release notes as plain text #254

@akordowski

Description

@akordowski

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
  • --includeDateInTitle true/false
    Defines if the date in the milestone title 0.1.0 (01.07.2020) is included or excluded.
    Default is the value of the yaml config export: include-created-date-in-title property.
  • --includeSubtitle true/false
    Defines if the subtitle As part of this release we had 1 issue closed. is included or excluded.
    Default true.
  • --includeLabels true/false
    Defines if the issues are separated by labels.
    Default true.
  • --includeIssueNumber true/false
    Defines if the issue number is included or excluded.
    Default true.
  • --includeFooter true/false
    Defines if the footer Where to get it is included or excluded.
    Default is the value of the yaml config create: include-footer property.

I would like to implement the changes and provide a PR.

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions