Add release summary section #654
Conversation
There was a problem hiding this comment.
This is a fun way of using Issues as a CMS - perhaps it’s a workflow which matches what a lot of people are already doing with a “prepare 2.0” Issue, where they use checklists and other ephemeral text snippets, which are then later (just before release) edited away, to become the release statement.
I kind of like this.
| @@ -123,6 +123,7 @@ def generate_body(pull_requests, issues) | |||
| # @return [Array] Section objects. | |||
| def default_sections | |||
| [ | |||
| Section.new(name: "summary", prefix: "", labels: @options[:summary_labels], options: @options, body_only:true), | |||
There was a problem hiding this comment.
Would you mind adding an @options[:summary_prefix] option that just defaults to ""? I actually really like the idea of summaries being under the version H2 line, but currently my company adds release summaries with a ### Summary prefix when writing release changelogs by hand. Eg: https://github.com/puppetlabs/puppetlabs-apache/blob/master/CHANGELOG.md
There was a problem hiding this comment.
+1 here. I'm not biased or anything, though.
There was a problem hiding this comment.
That makes sense.
I will add it later :)
|
I added label option for release summary section.
Set up custom label for release summary section. Default: '' |
There was a problem hiding this comment.
The next step is to document the new option in the man/ directory, and use ronn to generate documentation artifacts.
That can be done by you, or by someone else, whatever you prefer.
Thank you for sharing this solution with us, and thank you for making this tool more useful.
|
Is this all right? |
|
Looks great! thank you, @mob-sakai Since everybody approved this change: |
|
If you do not mind, please merge this PR... |
|
Yay! @olleolleolle 's back! 👍 I will leave it here as |
This PR allows us to create section for release summary.
Add the body of the issues with
release-sumarylabel.You can add attractive images and summary text about each releases.
Issues with these labels will be added to a new section, called "Release Summary".
The section display only body of issues.
Default: 'Release-summary,release-summary,Summary,summary'
This PR will fix #582