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

Add render subcommand #5

Open
gdemonet opened this issue Jan 12, 2021 · 5 comments
Open

Add render subcommand #5

gdemonet opened this issue Jan 12, 2021 · 5 comments
Labels
enhancement New feature or request
Milestone

Comments

@gdemonet
Copy link

Building on the list subcommand introduced in #4, we want to add the ability to generate a changelog / release notes from a list of fragments.

To select which fragments to include in the generated document, the same options as the list subcommand will be used.
To control the output contents and format, the following options will be added:

  • --release-notes will filter fragments to only include ones tagged with :release-notes:
  • --kind $KIND will filter fragments tagged with :kind: $KIND, where $KIND can be one of Feature, Bugfix, or Improvement (more kinds may be added in the future); this option can be used more than once - not specifying it implies all kinds are included
  • --epic $EPIC works similarly to the kind filter described above, but not specifying it allows to also include fragments without any :epic: specified; a --no-epic flag will be provided to only select such fragments
  • --output $FMT will allow to control the format of the generated document, akin to many existing command-line tools (e.g. kubectl); the only supported format in this initial implementation will be reStructuredText

In this issue, we will not consider automatic retrieval of pull request information.

@gdemonet gdemonet added this to the 0.1.0 milestone Jan 12, 2021
@NicolasT
Copy link
Contributor

Instead of enforcing a set of possible values for kind, should there be some configuration (file)?

@NicolasT
Copy link
Contributor

I'd rename this to render, and keep generate for another purpose (about to file an issue for it...)

@gdemonet
Copy link
Author

Instead of enforcing a set of possible values for kind, should there be some configuration (file)?

Not sure... There would be more configuration than just what values are allowed for a kind, because we need to know how to render a section for this kind (each kind would have a template? what about the overall document template?).
I think handling it this way requires more thought and effort, so let's keep it simple for now and maybe open an improvement task later, if we see the use-case.

I'd rename this to render, and keep generate for another purpose (about to file an issue for it...)

Good idea 👍!

@gdemonet gdemonet changed the title Add generate subcommand Add render subcommand Jan 12, 2021
@NicolasT
Copy link
Contributor

I think handling it this way requires more thought and effort, so let's keep it simple for now and maybe open an improvement task later, if we see the use-case.

👍 Potential future improvement/extension point.

@NicolasT
Copy link
Contributor

Wondering why list should not have the release-notes, kind, epic and no-epic flags...

NicolasT added a commit that referenced this issue Feb 2, 2021
NicolasT added a commit that referenced this issue Feb 2, 2021
NicolasT added a commit that referenced this issue Feb 2, 2021
@NicolasT NicolasT added the enhancement New feature or request label Jun 28, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants