standard-version icon indicating copy to clipboard operation
standard-version copied to clipboard

`signed-off-by` message showing up in breaking changes in the changelog

Open mowies opened this issue 4 years ago • 3 comments

I am using standard-version to create releases in my project. We have to use the signed-off-by feature of git, but now I have the sign-off messages showing up under the breaking changes in my changelog.

Is there some way to filter those out in the changelog? I don't think it's configurable from standard-version directly.

Current behavior Signed off commits with breaking changes result in the sign-off message showing up in the changelog.

Expected behavior The sign-off messages don't show up in the changelog.

Environment

  • standard-version 9.3.1
  • Node/npm version: Node 14 LTS
  • OS: ubuntu-20 (GH Actions), MacOS 11.4 (Big Sur)

Possible Solution A possible solution would be to add the possibility to pass through parser options for the commit parser from the .versionrc file or from the command line.

mowies avatar Jul 22 '21 09:07 mowies

We are also experiencing this issue. Worse is that the commit footers break rendering of the section because multi-lines are not correctly indented:

⚠ BREAKING CHANGES

  • amu: The public AMU API has been reduced to enablement only to facilitate refactoring work. These APIs were not previously used.

Change-Id: Ibf6174fb5b3949de3c4ba6847cce47d82a6bd08c Signed-off-by: Chris Kay [email protected]

  • amu: The PLAT_AMU_GROUP1_COUNTERS_MASK platform definition has been removed. Platforms should specify per-core AMU counter masks via FCONF or a platform-specific mechanism going forward.

Change-Id: I1e852797c7954f92409222b066a1ae57bc72bb05 Signed-off-by: Chris Kay [email protected]

  • fconf: FCONF is no longer added to BL1 and BL2 automatically when the FCONF Makefile (fconf.mk) is included. When including this Makefile, consider whether you need to add ${FCONF_SOURCES} and ${FCONF_DYN_SOURCES} to BL1_SOURCES and BL2_SOURCES.

Change-Id: Ic028eabb7437ae95a57c5bcb7821044d31755c77 Signed-off-by: Chris Kay [email protected]

  • drivers/arm/ethosn: multi-device support

CJKay avatar Nov 02 '21 15:11 CJKay

Hey @CJKay ! If you're interested, I implemented a workaround for this which works for now. I used a postchangelog shell script that filters out the signoff messages. My .versionrc.json can be found here The shell script can be found here

mowies avatar Nov 03 '21 07:11 mowies

Hey @CJKay ! If you're interested, I implemented a workaround for this which works for now. I used a postchangelog shell script that filters out the signoff messages. My .versionrc.json can be found here The shell script can be found here

Thanks, @mowies, I've worked around this with a custom preset extending the CC one to resolve this.

CJKay avatar Nov 03 '21 16:11 CJKay