diff options
Diffstat (limited to '')
| -rw-r--r-- | docs/index.md | 13 |
1 files changed, 8 insertions, 5 deletions
diff --git a/docs/index.md b/docs/index.md index c179c9e..5b371bf 100644 --- a/docs/index.md +++ b/docs/index.md @@ -15,7 +15,7 @@ Great for use as a [commit-msg git hook](#using-gitlint-as-a-commit-msg-hook) or !!! important - **Gitlint will soon be dropping support for Python 2.7 and Python 3.5 as they [have reached End-Of-Life](https://endoflife.date/python)**. + **Gitlint no longer supports Python 2.7 and Python 3.5 as they [have reached End-Of-Life](https://endoflife.date/python). The last gitlint version to support Python 2.7 and Python 3.5 is `0.14.0` (released on October 24th, 2020).** ## Features - **Commit message hook**: [Auto-trigger validations against new commit message right when you're committing](#using-gitlint-as-a-commit-msg-hook). Also [works with pre-commit](#using-gitlint-through-pre-commit). @@ -39,8 +39,8 @@ useful throughout the years. pip install gitlint # macOS -brew tap rockyluke/devops brew install gitlint +sudo port install gitlint # alternative using macports # Ubuntu apt-get install gitlint @@ -219,11 +219,14 @@ your `.pre-commit-config.yaml` file like so: rev: # Fill in a tag / sha here hooks: - id: gitlint - stages: [commit-msg] - entry: gitlint args: [--contrib=CT1, --msg-filename] ``` +!!! important + + You need to add `--msg-filename` at the end of your custom `args` list as the gitlint-hook will fail otherwise. + + ## Using gitlint in a CI environment By default, when just running `gitlint` without additional parameters, gitlint lints the last commit in the current working directory. @@ -426,4 +429,4 @@ Exit Code | Description -----------|------------------------------------------------------------ 253 | Wrong invocation of the `gitlint` command. 254 | Something went wrong when invoking git. -255 | Invalid gitlint configuration
\ No newline at end of file +255 | Invalid gitlint configuration |