feat(core): add Signed-off-by rule #53
Conversation
|
Thanks @adam-moss! Currently the tests are failing, specifically export-all-rules https://travis-ci.org/marionebl/commitlint/jobs/258568271#L651. Could you adapt your changes? |
adam-moss
force-pushed
the
feat/signed-off-by
branch
from
971f88a to
3e3b82d
Compare
|
Balls, no idea how I managed to miss that 😭 Hopefully that should've sorted it 👍 |
| @@ -0,0 +1,17 @@ | |||
| export default (parsed, when, value) => { | |||
| const input = parsed.raw; | |||
There was a problem hiding this comment.
According to my test Signed-off-by is added to the .body of a commit when using --signoff. Do you have a specific reason for using .raw here?
There was a problem hiding this comment.
Honestly? I went with raw as I was struggling to dump out what was in each part of parsed as ava seems to eat console.log calls (first time I've used ava so not sure of the proper way to insert simple debug statements).
If the commit is split into subject, body, footer I would actually expect the Signed-off-by: to be in the footer logically, if a body is present, or the body, if no body is present (which is what your test shows).
For example:
test(signoff): --signoff
this does something with git signoff
BREAKING
xyz
Signed-off-by: Adam Moss <an@email.address>--signoff puts it at the end of the commit message so I err'd on the side of caution with raw.
There was a problem hiding this comment.
Yes, I think your assessment is correct. Let's go with a solution where the check if the searched string is on the very last line of .raw. Please adapt accordingly and add a test cases with Signed-off-by found on other lines being ignored.
adam-moss
force-pushed
the
feat/signed-off-by
branch
from
3e3b82d to
5cb4f16
Compare
|
@marionebl right that's those additional changes in, happy to take suggestions for improving... |
adam-moss
force-pushed
the
feat/signed-off-by
branch
from
5cb4f16 to
022d705
Compare
adam-moss
force-pushed
the
feat/signed-off-by
branch
from
022d705 to
0ca3788
Compare
|
Thank you! |
|
Released with version 3.1.0 🎉 |
|
Nice one 👍 |
this object will replace the other variables, it is more easy to scale adding new properties. I'll extend the info in a future documents about plugins.
Added a new rule to allow for commit messages to be validated for the
Signed-off-by:syntax as added when doinggit commit --signoff.I think I've changed everything required for this, but please shout up if I've missed something.