scality / changelog-binder

Tooling to generate changelogs and release notes from snippets stored in a project Git repository, compatible with the GitWaterFlow branching model.
https://scality.github.io/changelog-binder/
Apache License 2.0
2 stars 1 forks source link

Add `render` subcommand #5

Open gdemonet opened 3 years ago

gdemonet commented 3 years ago

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:

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

NicolasT commented 3 years ago

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

NicolasT commented 3 years ago

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

gdemonet commented 3 years ago

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 :+1:!

NicolasT commented 3 years ago

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.

:+1: Potential future improvement/extension point.

NicolasT commented 3 years ago

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