Format multi-line change descriptions as a single bullet

[oobug]

As a user, I would like to be able to provide multi-line change descriptions and have the changelog output them by default to render as part of the same bullet in the Markdown file.

Currently, inputting a change description with multiple line breaks will result in subsequent lines being dedented, e.g.,

• minor: This is the first line of my change, followed by two line breaks

The following lines are dedented and do not render as part of the original bullet.

Instead, the default template should render any subsequent lines in the changelog as if they are part of the same bullet, e.g.

• minor: This is the first line of my change, followed by two line breaks

  The following lines are indented and render as part of the original bullet.

(This can be achieved by changing {{ change.description }} in the default template to {{ change.description | indent(2) }})

[oobug]

Note, I am planning to make pull requests for these issues, I'm not just filling up the issue feed arbitrarily. 😂

[raulgomis]

@oobug haha, thanks mate! I definitely appreciate your feedback and detailed comments. In regards to multi-line change descriptions: it is definitely something really useful, I thought about it in the past. I'd like to explore supporting Markdown for the change descriptions, that will give users support for multi-line and also more flexibility to format their changelogs. What do you think?

[oobug]

@raulgomis So far, my personal usage would not extend to using Markdown within my change descriptions. Although I am also aware that, using the built-in template, the contents of the change description will already be formatted as Markdown by virtue of being exported to a Markdown file. Is there something you're hoping to add to provide more explicit support for Markdown in change descriptions?

[raulgomis]

Hi @oobug , I just had a look into this pending issue. Any reason you can't use <br/> to do multi line support in Markdown? That works well.