Release notes don't display breaking changes obviously

[znewman01]

#354 is marked as breaking:

• refactor! with a ! in the conventional commit
• "breaking" box ticked in the PR
• "BREAKING CHANGE" in the PR description

However, it's in the 0.4.0 release, which doesn't call it out specifically. Should it?

(Or did I do something wrong?)

[rdimitrov]

Goreleaser uses a regex against the PR title to match if upon merge it should be added to a given group (i.e. the "Breaking changes" group).

So far we look for the following prefix -

go-tuf/.goreleaser/tuf.yml

Line 26 in 06ed599

regexp: "^.*BREAKING CHANGE[(\\w)]*:+.*$"

, but we can totally switch to something else 👍

Ticking the box and/or adding additional info in the description is useful to inform others and to highlight to the maintainers to make sure the title includes the necessary prefix so it gets handled properly in the release notes. It would be nice if there's a way to automate that in some way, i.e. ticking a box to alter the PR title, but I'm not aware of anything like that.

In any case, this part is missing from the docs, so I'll push an update to our guidelines 😃

[znewman01]

Gotcha. I would like to honor the ! convention from conventional commits, so let's change that regex. I can make a PR.

[znewman01]

FWIW the "BREAKING CHANGE" convention in convention commits isn't supposed to go in the PR title, it's supposed to be a footer. So I think looking for BREAKING CHANGE in the title in the regex is wrong, though probably not worth fixing.