Grammar does not enforce whitespace after : token in footers
#47
Comments
12 tasks
orhun
added a commit
to orhun/git-cliff
that referenced
this issue
Jun 16, 2024
* feat: Enable footer-based commit parsing
Enable defining parsers for a commit's footer, similar to the already-
present commit parsers for a commit's message or body.
For example:
```toml
commit_parsers = [
{ footer = "changelog: ignore", skip = true },
]
```
Due to an inconsistency between the conventional commits specification
and its reference parser, footers are currently interpreted as
`key:value` instead of the (correct) `key: value`. See
conventional-commits/parser#47 for details.
As a future-proof workaround, you can use `key: ?value` in the regex.
* chore: fix typo
---------
Co-authored-by: Orhun Parmaksız <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
As per conventional commits specification v1.0.0 §8: “Each footer MUST consist of a word token, followed by either a
:<space>or<space>#separator, followed by a string value.”However, the reference grammar currently specifies:
This is similar to but distinct from #41. The inconsintency was pointed out in crate-ci/git-conventional#54.
The text was updated successfully, but these errors were encountered: