Multiple changes in single commit doesn't always work

[rsenden]

While working with release-please-action, I've noticed a couple times that features or fixes that are listed in the body/footer of a commit message don't get included in the changelog.

I don't recall all the circumstances where this happened, but at least this seems to occur if there are lines in the commit message footer that do not adhere to the Conventional Commits layout.

As an example, following is the commit message for rsenden/release-please-test@868873d

feat: Feature with extra messages

feat: FeatExtraFooter1

feat: FeatExtraFoorer2

Some other text

Something else

As can be seen at https://github.com/rsenden/release-please-test/runs/2084824783?check_suite_focus=true#step:3:14, release-please only recognizes 1 feature instead of the 3 features listed in this commit message. This can also be seen in the generated pull request, where the changelog doesn't list the FeatExtraFooter1 and FeatExtraFooter2 features: rsenden/release-please-test#4

[live627]

seems to work for me?

live627/SCEditor@d6fcbbc

live627/SCEditor#37

so maybe it only works for node...

[bcoe]

@live627 @rsenden the it has to do with the parser. We parse footers from the bottom up, so when the text is broken up like:

footer: a
footer: b

free form text that doesn't look like a footer.

The multiple footers are not parsed.

[rsenden]

it has to do with the parser. We parse footers from the bottom up

Good to know, any plans to get this fixed? Maybe in the meantime it would be good to add a note about this to the documentation.

[bcoe]

@rsenden this was an intentional decision when we wrote the parser, due to it being ambiguous as to which parse goal we'd like.

No immediate plan to fix, so updating docs might be a good compromise.

[tswast]

I'd like to +1 the need for docs improvements. Looking at the "What if my PR contains multiple fixes or features?" section in the README, I see all the example extra commits include "PiperOrigin-RevId: 345559154". It's not clear to me if this is required or not, and is confusing if working on a repo that isn't mirrored from google3/piper.

[live627]

it's not strictly required

…

On Wed, Nov 17, 2021 at 1:53 PM Tim Swast ***@***.***> wrote: I'd like to +1 the need for docs improvements. Looking at the "What if my PR contains multiple fixes or features?" section in the README, I see all the example extra commits include "PiperOrigin-RevId: 345559154". It's not clear to me if this is required or not, and is confusing if working on a repo that isn't mirrored from google3/piper. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#821 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AADJNNZCHNXMJC6XNET3IGLUMQI4DANCNFSM4ZAIOCCQ> . Triage notifications on the go with GitHub Mobile for iOS <https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675> or Android <https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub>.