Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
akordowski opened this issue Jul 24, 2020 · 3 comments
Open

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

akordowski opened this issue Jul 24, 2020 · 3 comments
Assignees
Labels
Milestone

Comments

@akordowski
Copy link
Contributor

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.

@gep13
Copy link
Member

gep13 commented Jul 25, 2020

@akordowski these seem like you very good additions to the export command. I would love to see a PR to get this implemented.

@akordowski
Copy link
Contributor Author

Great, then I will go to work the next days.

@gep13
Copy link
Member

gep13 commented Apr 19, 2021

Similar to the other issue that you raised, going to bump this to a future release.

@gep13 gep13 modified the milestones: 0.12.0, Future Apr 19, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants