fix: update commitlint to version 11.0.0 (strimzi#25)

* fix: update commitlint to version 11.0.0 Closes strimzi#23 Signed-off-by: Jordan <[email protected]> * fix: remove other reference to commitlint bug Signed-off-by: Jordan <[email protected]>
nictownsend · Oct 2, 2020 · 2a17c14 · 2a17c14
1 parent cdf6bbe
commit 2a17c14
Show file tree

Hide file tree

Showing 4 changed files with 343 additions and 251 deletions.
diff --git a/README.md b/README.md
@@ -38,52 +38,3 @@ Further details around how this UI is implemented can be found below:
 - [Build](./docs/Build.md)
 - [Linting](./docs/Linting.md)
 - [Test](./docs/Test.md)
-
-### Known issues
-
-#### `Signed-off-by` reported as not included in commit, when it is included
-
-When making a commit, your commit message may look as follows:
-
-```
-feat: new feature
-
-- adds feature X
-
-Signed-off-by: Matthew <matthew@domain>
-
-# Please enter the commit message for your changes. Lines starting
-# with '#' will be ignored, and an empty message aborts the commit.
-#
-# Date:      <date>
-#
-# On branch X
-# Changes to be committed:
-#	modified:   file
-```
-
-but this is rejected by commitlint:
-
-```
-husky > commit-msg (node v10.15.0)
-⧗   input: feat: new feature
-
-- adds feature X
-
-Signed-off-by: Matthew <matthew@domain>
-✖   message must be signed off [signed-off-by]
-
-✖   found 1 problems, 0 warnings
-ⓘ   Get help: https://github.com/conventional-changelog/commitlint/#what-is-commitlint
-```
-
-This is due to [this bug](https://github.com/conventional-changelog/commitlint/issues/1809), where comments are parsed/not ignored. While this issues exists, you can work around this by removing all comments from your message, ie:
-
-```
-feat: new feature
-
-- adds feature X
-
-Signed-off-by: Matthew <matthew@domain>
-
-```
diff --git a/docs/Linting.md b/docs/Linting.md
@@ -52,8 +52,6 @@ The following must be present in all git commits made to this repository. These
 
 These checks can only be run having made a `git commit`.
 
-_Important note_: If you run into issues with the `All commits must have a signed-off-by entry` rule, [see this known issue, which covers a workaround for a known bug.](../README.md#signed-off-by-reported-as-not-included-in-commit,-when-it-is-included)
-
 ### JS code
 
 These checks are enforced by `eslint`, and the configuration [here](../utils/linting/eslint.config.js).