Updating documentation prior to 0.9.0 release

Also updated .travis.yml file to run integration tests for certain
environments. These tests still fail intermittently on travis.
Hopefully enabling them will give us more insight into when and why.

Author: jroovers-cisco

.travis.yml

@@ -9,28 +9,51 @@ matrix:
       os: linux
     - python: "3.3"
       os: linux
+      script:
+      # Skip integration tests in Travis for Python 3.3, need to look into this
+      # Error example: https://travis-ci.org/jorisroovers/gitlint/jobs/310861373
+        - "./run_tests.sh"
+        - "./run_tests.sh --build"
+        - "./run_tests.sh --pep8"
+        - "./run_tests.sh --lint"
+        - "./run_tests.sh --git"
     - python: "3.4"
       os: linux
+      script:
+      # Skip integration tests in Travis for Python 3.4, need to look into this
+      # Error example: https://travis-ci.org/jorisroovers/gitlint/jobs/310861374
+        - "./run_tests.sh"
+        - "./run_tests.sh --build"
+        - "./run_tests.sh --pep8"
+        - "./run_tests.sh --lint"
+        - "./run_tests.sh --git"
     - python: "3.5"
       os: linux
-      # Skip lint tests for python 3.6 (see https://github.com/PyCQA/pylint/issues/1072)
+      script:
+      # Skip integration tests in Travis for Python 3.5, need to look into this
+      # Error example: https://travis-ci.org/jorisroovers/gitlint/jobs/310861375
+        - "./run_tests.sh"
+        - "./run_tests.sh --build"
+        - "./run_tests.sh --pep8"
+        - "./run_tests.sh --lint"
+        - "./run_tests.sh --git"
     - python: "3.6"
       os: linux
       script:
-       - "./run_tests.sh"
-       - "./run_tests.sh --build"
-       - "./run_tests.sh --pep8"
-       - "./run_tests.sh --git"
+      # Skip lint tests for python 3.6 (see https://github.com/PyCQA/pylint/issues/1072)
+        - "./run_tests.sh"
+        - "./run_tests.sh --integration"
+        - "./run_tests.sh --build"
+        - "./run_tests.sh --pep8"
+        - "./run_tests.sh --git"
     - python: "pypy"
       os: linux
-    - python: "2.7"
-      os: osx
-      script: "pip --version"
 install:
   - "pip install -r requirements.txt"
   - "pip install -r test-requirements.txt"
 script:
  - "./run_tests.sh"
+ - "./run_tests.sh --integration"
  - "./run_tests.sh --build"
  - "./run_tests.sh --pep8"
  - "./run_tests.sh --lint"

CHANGELOG.md

@@ -1,21 +1,38 @@
 # Changelog #
 
-## v0.9.0 (In Progress) ##
+## v0.9.0 (2017-12-03) ##
+The 0.9.0 release adds a new default ```author-valid-email``` rule, important bugfixes and special case handling.
+Special thanks to [joshholl](https://github.com/joshholl), [ron8mcr](https://github.com/ron8mcr),
+[omarkohl](https://github.com/omarkohl), [domo141](https://github.com/domo141), [nud](https://github.com/nud)
+and [AlexMooney](https://github.com/AlexMooney) for their contributions.
 
 - New Rule: ```author-valid-email``` enforces a valid author email address. Details can be found in the
-  [Rules section of the documentation](http://jorisroovers.github.io/gitlint/rules/).
+  [Rules section of the documentation](http://jorisroovers.github.io/gitlint/rules/#m1-author-valid-email).
 - **Breaking change**: The ```--commits``` commandline flag now strictly follows the refspec format as interpreted
   by the [```git rev-list <refspec>```](https://git-scm.com/docs/git-rev-list) command. This means
   that linting a single commit using ```gitlint --commits <SHA>``` won't work anymore. Instead, for single commits,
   users now need to specificy ```gitlint --commits <SHA>^...<SHA>```. On the upside, this change also means
   that gitlint will now understand all refspec formatters, including ```gitlint --commits HEAD``` to lint all commits
-  in the repository.
+  in the repository. This fixes [#23](https://github.com/jorisroovers/gitlint/issues/40).
+- **Breaking change**: Gitlint now always falls back on trying to read a git message from a local git repository, only
+  reading a commit message from STDIN if one is passed. Before, gitlint only read from the local git repository when
+  a TTY was present. This is likely the expected and desired behavior for anyone running gitlint in a CI environment.
+  This fixes [#40](https://github.com/jorisroovers/gitlint/issues/40) and
+  [#42](https://github.com/jorisroovers/gitlint/issues/42).
+- **Behavior Change**: Gitlint will now by default
+  [ignore squash and fixup commits](http://jorisroovers.github.io/gitlint/#merge-fixup-and-squash-commits)
+  (fix for [#33: fixup messages should not trigger a gitlint violation](https://github.com/jorisroovers/gitlint/issues/33))
+- Support for custom comment characters ([#34](https://github.com/jorisroovers/gitlint/issues/34))
+- Support for [```git commit --cleanup=scissors```](https://git-scm.com/docs/git-commit#git-commit---cleanupltmodegt)
+  ([#34](https://github.com/jorisroovers/gitlint/issues/34))
+- Bugfix: [#37: Prevent Commas in text fields from breaking git log printing](https://github.com/jorisroovers/gitlint/issues/37)
 - Debug output improvements
 
 ## v0.8.2 (2017-04-25) ##
 
-The 0.8.2 release brings minor improvements, bugfixes and some under-the-hood changes. Special thanks to 
+The 0.8.2 release brings minor improvements, bugfixes and some under-the-hood changes. Special thanks to
 [tommyip](https://github.com/tommyip) for his contributions.
+
 - ```--extra-path``` now also accepts a file path (in the past only directory paths where accepted).
 Thanks to [tommyip](https://github.com/tommyip) for implementing this!
 - gitlint will now show more information when using the ```--debug``` flag. This is initial work and will continue to

CONTRIBUTING.md

@@ -0,0 +1,6 @@
+# Contributing
+
+Thanks for your interest in contributing to gitlint!
+
+Instructions on how to get started can be found on [http://jorisroovers.github.io/gitlint/contributing](http://jorisroovers.github.io/gitlint/contributing/).
+

README.md

@@ -7,14 +7,14 @@
 
 Git commit message linter written in python, checks your commit messages for style.
 
-**See [jorisroovers.github.io/gitlint/](http://jorisroovers.github.io/gitlint/) for full documentation.**
+**See [jorisroovers.github.io/gitlint](http://jorisroovers.github.io/gitlint/) for full documentation.**
 
 <a href="http://jorisroovers.github.io/gitlint/" target="_blank"><img src="https://asciinema.org/a/30477.png" width="640"/></a>
 
 ## Contributing ##
 All contributions are welcome and very much appreciated!
 
 See [jorisroovers.github.io/gitlint/contributing](http://jorisroovers.github.io/gitlint/contributing) for details on
-how to get started - it's easy! 
+how to get started - it's easy!
 
 FYI, we maintain a [wishlist on our wiki](https://github.com/jorisroovers/gitlint/wiki/Wishlist).

docs/contributing.md

@@ -1,9 +1,24 @@
-We'd love for you to [contribute to gitlint](https://github.com/jorisroovers/gitlint).
-Just create an issue or open a pull request. Sometimes it takes a while for me to get back to you
-(this is a hobby project), but rest assured that we read your message and appreciate your interest!
+We'd love for you to contribute to gitlint. Thanks for your interest!
+Sometimes it takes a while for [me](https://github.com/jorisroovers) to
+get back to you (this is a hobby project), but rest assured that we read your message and appreciate your interest!
 We maintain a [wishlist on our wiki](https://github.com/jorisroovers/gitlint/wiki/Wishlist),
 but we're obviously open to any suggestions!
 
+# Guidelines
+
+When contributing code, please consider all the parts that are typically required:
+
+- [Unit tests](https://github.com/jorisroovers/gitlint/tree/master/gitlint/tests) (automatically
+  [enforced by Travis](https://travis-ci.org/jorisroovers/gitlint)). Please consider writing
+  new ones for your functionality, not only updating existing ones to make the build pass.
+- [Integration tests](https://github.com/jorisroovers/gitlint/tree/master/qa) (also automatically
+  [enforced by Travis](https://travis-ci.org/jorisroovers/gitlint)). Again, please consider writing new ones
+  for your functionality, not only updating existing ones to make the build pass.
+- [Documentation](https://github.com/jorisroovers/gitlint/tree/master/docs)
+
+Since we want to maintain a high standard of quality, all of these things will have to be done regardless before code
+can make it as part of a release. If you can already include them as part of your PR, it's a huge timesaver for us
+and it's likely that your PR will be merged and released a lot sooner. Thanks!
 # Development #
 
 There is a Vagrantfile in this repository that can be used for development.

docs/index.md

@@ -1,7 +1,8 @@
 # Intro #
 Gitlint is a git commit message linter written in python: it checks your commit messages for style.
 
-Great for use as a ```commit-msg``` git hook or as part of your gating script in a CI/CD pipeline (e.g. jenkins).
+Great for use as a [commit-msg git hook](#using-gitlint-as-a-commit-msg-hook) or as part of your gating script in a
+[CI pipeline (e.g. Jenkins)](index.md#using-gitlint-in-a-ci-environment).
 
 <script type="text/javascript" src="https://asciinema.org/a/30477.js" id="asciicast-30477" async></script>
 
@@ -13,7 +14,7 @@ Great for use as a ```commit-msg``` git hook or as part of your gating script in
 ## Features ##
  - **Commit message hook**: [Auto-trigger validations against new commit message right when you're committing](#using-gitlint-as-a-commit-msg-hook).
  - **Easily integrated**: Gitlint will validate any git commit message you give it via standard input.
-   Perfect for [integration with your own scripts or CI system](#using-gitlint-in-a-cicd-script).
+   Perfect for [integration with your own scripts or CI system](#using-gitlint-in-a-ci-environment).
  - **Sane defaults:** Many of gitlint's validations are based on
 [well-known](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html),
 [community](http://addamhardy.com/blog/2013/06/05/good-commit-messages-and-enforcing-them-with-git-hooks/),
@@ -82,6 +83,7 @@ The default verbosity is ```-vvv```.
 Other commands and variations:
 
 ```no-highlight
+$ gitlint --help
 Usage: gitlint [OPTIONS] COMMAND [ARGS]...
 
   Git lint tool, checks your git commit messages for styling issues
@@ -133,24 +135,30 @@ gitlint uninstall-hook
     file in your local repository, gitlint will refuse to install the ```commit-msg``` hook. Gitlint will also only
     uninstall unmodified commit-msg hooks that were installed by gitlint.
 
-## Using gitlint in a CI/CD script ##
+## Using gitlint in a CI environment ##
 By default, when just running ```gitlint``` without additional parameters, gitlint lint the last commit in the current
 git repository.
 
-This makes it easy to add gitlint to a check script that is run in a CI environment. In fact, this is exactly what we
-do ourselves: on every commit,
+This makes it easy to add gitlint to a check script that is run in a CI environment (Jenkins, TravisCI, pre-commit,
+CircleCI, etc).
+In fact, this is exactly what we do ourselves: on every commit,
 [we run gitlint as part of our travisCI tests](https://github.com/jorisroovers/gitlint/blob/v0.7.1/run_tests.sh#L62-L65).
 This will cause the build to fail when we submit a bad commit message.
 
-Gitlint will also lint any commit message that you feed it via stdin like so:
+
+!!! note
+    Versions prior to gitlint 0.9.0 required a TTY to be attached to STDIN for this to work, this is no longer required
+    now.
+
+Alternatively, gitlint will also lint any commit message that you feed it via stdin like so:
 ```bash
 # lint the last commit message
 git log -1 --pretty=%B | gitlint
 # lint a specific commit: 62c0519
 git log -1 --pretty=%B 62c0519 | gitlint
 ```
-For now, it's required that you specify ```--pretty=%B``` (=only print the log message, not the metadata),
-future versions of gitlint might fix this.
+Note that gitlint requires that you specify ```--pretty=%B``` (=only print the log message, not the metadata),
+future versions of gitlint might fix this and not require the ```--pretty``` argument.
 
 ## Linting a range of commits ##
 _Experimental support introduced in gitlint v0.8.1, known issues:_

docs/rules.md

@@ -176,7 +176,7 @@ M1    |  author-valid-email         | >= 0.8.3        | Author email address mus
 
 Name                  | gitlint version   | Default                      | Description
 ----------------------|-------------------|------------------------------|----------------------------------
-regex                 | >= 0.8.3          | ```[^@ ]+@[^@ ]+\.[^@ ]+```  |  Regex the commit author email address is matched against
+regex                 | >= 0.9.0          | ```[^@ ]+@[^@ ]+\.[^@ ]+```  |  Regex the commit author email address is matched against
 
 
 !!! note

setup.py

@@ -13,7 +13,7 @@
 
 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/CD 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).
 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.