feat(core): ignore version commits with footers

[krotscheck]

Edit by @marionebl:

• Add support for version commits with footers, e.g. as produced by --sign-off or Gerrit.
• Add relevant test cases

[marionebl]

Looks good, thanks. I am on vacation till 3th Oct, will make an effort to merge it then!

[krotscheck]

👍

[marionebl]

One comment about the specificity of the ignore pattern.

[marionebl]

Reading the tests I guess the new intended behaviour is to support npm-generated semver commits with Signed-off-by note. This allows any given body, right?

Let's keep the implementation as specific as possible and check if the first line is semver and the body is a Signed-off-by note. Pseudo code:

c => semver.valid(c.trim()),
c => {
   const [header, ...body] = c.split('\n');
   if (body.length > 1) {
     return false:
   }
   const [signed] = body;
   return semver.valid(header.trim()) && signed.startsWith('Signed-off-by');
}

[krotscheck]

It's actually deliberately generic. Our own use case (which, admittedly, isn't everyone) is that Gerrit Code Review appends the Change-Id: I<really_long_hex_string> at the end of every commit. I figured: Well, there's N > 1 types of footers, so might as well make it generic.

I can appreciate the need for more specificity though, perhaps the regex should match an arbitrary-length list of <key>: <value> pairs instead?

[marionebl]

Ok, understood. I'd like to support the Gerrit use case.

• All Expected/supported commit formats should be in the test case.
• The matcher function can be simplified by splitting with \n instead and discarding everything after the first line.

[krotscheck]

Alright, changes made.

[marionebl]

Did a minor refactoring to the new test case, test failures are a bit easier to decipher this way.

[marionebl]

Published via4.1.0 🚀 Thank you!