googleapis / googleapis/release-please

support multiple BREAKING CHANGE footers

Open
#856 5 comments 2 reactions 0 assignees View on GitHub
type: feature request
Dominant language
TypeScript
Stars
7.5k
Forks
588
Avg merge
12h 16m
Merged PRs (30d)
7

Description

**Is your feature request related to a problem? Please describe.**

Sometimes, a commit may introduce more than a single breaking change, in which case it makes sense to have multiple separate lines for each breaking change in the changelog. This is currently not possible, because `release-please` only uses the last `BREAKING CHANGE:` footer in the commit message.

**Describe the solution you'd like**

I would like that each separate `BREAKING CHANGE:` footer creates a new line in the "BREAKING CHANGES" section of the changelog.

**Describe alternatives you've considered**

We considered writing everything in the same footer, but since it is not possible to add new lines in the changelog entry, that is suboptimal.

**Additional context**

See https://github.com/cheminfo-js/test/pull/11 for an example release PR created from commit https://github.com/cheminfo-js/test/commit/aa9c24e0a229e93845de160e44d276ac6506219c

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.