diff options
author | Joris Roovers <jroovers@cisco.com> | 2018-04-15 13:39:31 +0200 |
---|---|---|
committer | Joris Roovers <jroovers@cisco.com> | 2018-04-15 13:40:41 +0200 |
commit | e4e627dd5b5f1dbc1168782ea6fd9874242fa41a (patch) | |
tree | e86eb926e1e9600e21081ed54e622269a48fbc44 | |
parent | 8eefab08c468e5ef4814df11512a441b5de6edcc (diff) |
Minor documentation updates prior to 0.10.0 release
Nothing major, just minor tweaks.
-rw-r--r-- | CHANGELOG.md | 6 | ||||
-rw-r--r-- | README.md | 2 | ||||
-rw-r--r-- | docs/index.md | 13 | ||||
-rw-r--r-- | setup.py | 2 |
4 files changed, 12 insertions, 11 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md index 76274b1..72f5b17 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,6 @@ # Changelog # -## Unreleased: v0.10.0 (2018-04-?) ## +## v0.10.0 (2018-04-15) ## The 0.10.0 release adds the ability to ignore commits based on their contents, support for [pre-commit](https://pre-commit.com/), and important fix for running gitlint in CI environments (such as Jenkins, Gitlab, etc). @@ -13,10 +13,10 @@ python version to 2.7 or 3.3+. Future versions of gitlint are likely to drop sup Full Changelog: -- New Rule: ```ignore-by-title``` allows users to +- **New Rule**: ```ignore-by-title``` allows users to [ignore certain commits](http://jorisroovers.github.io/gitlint/#ignoring-commits) by matching a regex against a commit message title. ([#54](https://github.com/jorisroovers/gitlint/issues/54), [#57](https://github.com/jorisroovers/gitlint/issues/57)). -- New Rule: ```ignore-by-body``` allows users to +- **New Rule**: ```ignore-by-body``` allows users to [ignore certain commits](http://jorisroovers.github.io/gitlint/#ignoring-commits) by matching a regex against a line in a commit message body. - Gitlint now supports [pre-commit.com](https://pre-commit.com). @@ -5,7 +5,7 @@ [![PyPi Package](https://img.shields.io/pypi/v/gitlint.png)](https://pypi.python.org/pypi/gitlint) ![Supported Python Versions](https://img.shields.io/pypi/pyversions/gitlint.svg) -Git commit message linter written in python, checks your commit messages for style. +Git commit message linter written in python (for Linux and Mac), checks your commit messages for style. **See [jorisroovers.github.io/gitlint](http://jorisroovers.github.io/gitlint/) for full documentation.** diff --git a/docs/index.md b/docs/index.md index aba5a88..0b7ef07 100644 --- a/docs/index.md +++ b/docs/index.md @@ -7,9 +7,11 @@ Great for use as a [commit-msg git hook](#using-gitlint-as-a-commit-msg-hook) or <script type="text/javascript" src="https://asciinema.org/a/30477.js" id="asciicast-30477" async></script> !!! note - Gitlint is not the only git commit message linter out there, if you are looking for an alternative written in a different language, - have a look at [fit-commit](https://github.com/m1foley/fit-commit) (Ruby) or - [node-commit-msg](https://github.com/clns/node-commit-msg) (Node.js). + Gitlint is currently [**not** supported on Windows](https://github.com/jorisroovers/gitlint/issues/20). + + Also, gitlint is not the only git commit message linter out there, if you are looking for an alternative written in a different language, + have a look at [fit-commit](https://github.com/m1foley/fit-commit) (Ruby), + [node-commit-msg](https://github.com/clns/node-commit-msg) (Node.js) or [commitlint](http://marionebl.github.io/commitlint) (Node.js). ## Features ## - **Commit message hook**: [Auto-trigger validations against new commit message right when you're committing](#using-gitlint-as-a-commit-msg-hook). @@ -190,8 +192,8 @@ Gitlint allows users to commit a number of commits at once like so: gitlint --commits 019cf40...d6bc75a # You can also use git's special references: gitlint --commits origin..HEAD -# Or specify a single specific commit: -gitlint --commits 6f29bf81a8322a04071bb794666e48c443a90360 +# Or specify a single specific commit in refspec format, like so: +gitlint --commits 019cf40^...019cf40 ``` The ```--commits``` flag takes a **single** refspec argument or commit range. Basically, any range that is understood @@ -287,4 +289,3 @@ Exit Code | Description 253 | Wrong invocation of the ```gitlint``` command. 254 | Something went wrong when invoking git. 255 | Invalid gitlint configuration - @@ -15,7 +15,7 @@ except: description = "Git commit message linter written in python, checks your commit messages for style." long_description = """ -Great for use as a commit-msg git hook or as part of your gating script in a CI pipeline (e.g. jenkins). +Great for use as a commit-msg git hook or as part of your gating script in a CI pipeline (e.g. jenkins, gitlab). Many of the gitlint validations are based on `well-known`_ community_ `standards`_, others are based on checks that we've found useful throughout the years. Gitlint has sane defaults, but you can also easily customize it to your own liking. |