How can we highlight breaking changes?

[gerhard]

My understanding of https://keepachangelog.com/en/1.0.0/ is that all Changed items are breaking by default since existing functionality changes. Is there a way to make this more obvious?

This does not seem obvious enough:

This seems better to me:

It would also be important to list the breaking changes first, since they are the most important part of a release for end-users.

Given this starting point - https://github.com/dagger/dagger/blob/62ab7216d8b6f01fe3348778aa909b57dc68d420/sdk/python/.changie.yaml - how would you recommend @miniscruff that we went about this?

---

cc @helderco
👋 @olivierlacan https://changelog.com/podcast/127

[miniscruff]

Kinds are in sorted order from the config and can be customized via the https://changie.dev/config/#kindconfig-type options. For your particular question I would do something like:

kinds:
  - label: Breaking Changes
    format: '### :fire: **Breaking Changes**'
  - label: Added
  - label: Deprecated
  - label: Fixed
  - label: Dependencies

Customize as you wish but just remember the order is preserved and you can separate the prompt label from the final output via the format.
You can also further customize change format or even adding additional prompts only for that kind, eg if you wanted to link to a CVE or something idk.

[gerhard]

format is exactly what I was looking for.

Knowing that ordering is preserved makes this super straightforward.

💯

[sheldonhull]

@gerhard a link to how I do this and example output. I've played with various go templates and I'm pretty happy with this so far.

Also from the dagger repo, thought I'd mention that the {{.Component}} can be used to help define "engine", and other types that you use for your prefixes on each line since you aren't using multi-line entries I see. (body -> block: true).

That would like sorta like:

changeFormat: '- _{{.Component}}_: {{ .Body -}}'