gitlint

Contributors: Special thanks to all contributors for this release, in particular andersk and sigmavirus24.

• Gitlint is now split in 2 packages: gitlint and gitlint-core. This allows users to install gitlint without pinned dependencies (which is the default) (#162)
• Under-the-hood: dependencies updated

Contributors: Special thanks to all contributors for this release, in particular sigmavirus24, l0b0 and rafaelbubach.

• Python 3.10 support
• New Rule: ignore-by-author-name allows users to skip linting commit messages made by specific authors
• --commit <SHA> flag to more easily lint a single commit message (#141)
• --fail-without-commits flag will force gitlint to fail (exit code 253) when the target commit range is empty (typically when using --commits) (#193)
• Bugfixes:
  • contrib-title-conventional-commits (CT1) now properly enforces the commit type (#185)
  • contrib-title-conventional-commits (CT1) now supports the BREAKING CHANGE symbol "!" (#186)
• Heads-up: Python 3.6 will become EOL at the end of 2021. It's likely that future gitlint releases will stop supporting Python 3.6 as a result. We will continue to support Python 3.6 as long as its easily doable, which in practice usually means as long as our dependencies support it.
• Under-the-hood: dependencies updated, test and github action improvements.

Contributors: Special thanks to all contributors for this release, in particular PW999, gsemet and Lorac.

Bugfixes:

• Git commit message body with only new lines is not longer considered empty by body-is-missing (#176)
• Added compatibility with git commit -s for contrib-requires-signed-off-by rule (#178)
• Minor tweak to gitlint commit-hook output (#173)
• All dependencies have been upgraded to the latest available versions (Click==7.1.2, arrow==1.0.3, sh==1.14.1).
• Minor doc fixes

Contributors: Special thanks to BrunIF, lukech, Cielquan, harens and sigmavirus24.

This release drops support for Python 2.7 and Python 3.5 (both are EOL). Other than a few minor fixes, there are no functional differences from the 0.14.0 release.

Other call-outs:

• Mac users: Gitlint can now be installed using both homebrew (upgraded to latest) and macports. Special thanks to @harens for maintaining these packages (best-effort).
• Bugfix: Gitlint now properly handles exceptions when using its built-in commit-msg hook (#166).
• All dependencies have been upgraded to the latest available versions (Click==7.1.2, arrow==0.17.0, sh==1.14.1).
• Much under-the-hood refactoring as a result of dropping Python 2.7

Contributors: Special thanks to all contributors for this release, in particular @mrshu, @glasserc, @strk, @chgl, @melg8 and @sigmavirus24.

• IMPORTANT: Gitlint 0.14.x will be the last gitlint release to support Python 2.7 and Python 3.5, as both are EOL which makes it difficult to keep supporting them.
• Python 3.9 support
• New Rule: title-min-length enforces a minimum length on titles (default: 5 chars) (#138)
• New Rule: body-match-regex allows users to enforce that the commit-msg body matches a given regex (#130)
• New Rule: ignore-body-lines allows users to ignore parts of a commit by matching a regex against the lines in a commit message body (#126)
• Named Rules allow users to have multiple instances of the same rule active at the same time. This is useful when you want to enforce the same rule multiple times but with different options (#113, #66)
• User-defined Configuration Rules allow users to dynamically change gitlint's configuration and/or the commit before any other rules are applied.
• The commit-msg hook has been re-written in Python (it contained a lot of Bash before), fixing a number of platform specific issues. Existing users will need to reinstall their hooks (gitlint uninstall-hook; gitlint install-hook) to make use of this.
• Most general options can now be set through environment variables (e.g. set the general.ignore option via GITLINT_IGNORE=T1,T2). The list of available environment variables can be found in the configuration documentation.
• Users can now use self.log.debug("my message") for debugging purposes in their user-defined rules. Debug messages will show up when running gitlint --debug.
• Breaking: User-defined rule id's can no longer start with 'I', as those are reserved for built-in gitlint ignore rules.
• New RegexOption rule option type for use in user-defined rules. By using the RegexOption, regular expressions are pre-validated at gitlint startup and compiled only once which is much more efficient when linting multiple commits.
• Bugfixes:
  • Improved UTF-8 fallback on Windows (ongoing - #96)
  • Windows users can now use the 'edit' function of the commit-msg hook (#94)
  • Doc update: Users should use --ulimit nofile=1024 when invoking gitlint using Docker (#129)
  • The commit-msg hook was broken in Ubuntu's gitlint package due to a python/python3 mismatch (#127)
  • Better error message when no git username is set (#149)
  • Options can now actually be set to None (from code) to make them optional.
  • Ignore rules no longer have "None" as default regex, but an empty regex - effectively disabling them by default (as intended).
• Contrib Rules:
  • Added 'ci' and 'build' to conventional commit types (#135)
• Under-the-hood: minor performance improvements (removed some unnecessary regex matching), test improvements, improved debug logging, CI runs on pull requests, PR request template.

• Patch to enable --staged flag for pre-commit.
• Minor doc updates (#109)

• Behavior Change: Revert Commits are now recognized and ignored by default (#99)
• --staged flag: gitlint can now detect meta-data (such as author details, changed files, etc) of staged/pre-commits. Useful when you use gitlint's commit-msg hook or precommit (#105)
• New branch properties on GitCommit and GitContext, useful when writing your own user-defined rules: commit.branches and commit.context.current_branch (#108)
• Python 3.8 support
• Python 3.4 no longer supported. Python 3.4 has reached EOL and an increasing of gitlint's dependencies have dropped support which makes it hard to maintain.
• Improved Windows support: better unicode handling. Issues remain but the basic functionality works.
• Bugfixes:
  • Gitlint no longer crashes when acting on empty repositories (this only occurred in specific circumstances).
  • Changed files are now better detected in repos that only have a root commit
• Improved performance and memory (gitlint now caches git properties)
• Improved --debug output
• Improved documentation
• Under-the-hood: dependencies updated, unit and integration test improvements, migrated from TravisCI to Github Actions.

Contributors: Special thanks to all contributors for this release, in particular @rogalksi and @byrney.

• Contrib Rules: community-contributed rules that are disabled by default, but can be enabled through configuration. Contrib rules are meant to augment default gitlint behavior by providing users with rules for common use-cases without forcing these rules on all gitlint users.
  • New Contrib Rule: contrib-title-conventional-commits enforces the Conventional Commits spec. Details in our documentation.
  • New Contrib Rule: cc1-contrib-requires-signed-off-by ensures that all commit messages contain a Sign-Off-By line. Details in our documentation.
  • If you're interested in adding new Contrib rules to gitlint, please start by reading the Contributing page. Thanks for considering!
• Experimental (!) Windows support: Basic functionality is working, but there are still caveats. For more details, please refer to #20 and the open issues related to Windows.
• Python 3.3 no longer supported. Python 3.4 is likely to follow in a future release as it has reached EOL as well.
• PyPy 3.5 supported
• Support for --ignore-stdin command-line flag to ignore any text send via stdin. (#56, #89)
• Bugfixes:
  • #68: Can't use install-hooks in with git worktree
  • #59: gitlint failed with configured commentchar
• Under-the-hood: dependencies updated, experimental Dockerfile, github issue template.

• Python 3.7 support
• Python 2.6 no longer supported
• Various dependency updates and under the hood fixes (see #76 for details)

Special thanks to @pbregener for his contributions related to python 3.7 support and test fixes.

The 0.10.0 release adds the ability to ignore commits based on their contents, support for pre-commit, and important fix for running gitlint in CI environments (such as Jenkins, Gitlab, etc).

Special thanks to @asottile, @bdrung, @pbregener, @torwald-sergesson, @RykHawthorn, @SteffenKockel and @tommyip for their contributions.

Since it's becoming increasingly hard to support Python 2.6 and 3.3, we'd like to encourage our users to upgrade their python version to 2.7 or 3.3+. Future versions of gitlint are likely to drop support for Python 2.6 and 3.3.

Full Changelog:

• New Rule: ignore-by-title allows users to ignore certain commits by matching a regex against a commit message title. (#54, #57).
• New Rule: ignore-by-body allows users to ignore certain commits by matching a regex against a line in a commit message body.
• Gitlint now supports pre-commit.com. Details in our documentation (#62).
• Gitlint now has a --msg-filename commandline flag that allows you to specify the commit message to lint via a file (#39).
• Gitlint will now be silent by default when a specified commit range is empty (#46).
• Gitlint can now be installed on MacOS by brew via the homebrew-devops tap. To get the latest version of gitlint, always use pip for installation.
• If all goes well, gitlint will also be available as a package in the Ubuntu 18.04 repositories.
• Bugfixes:
  • We fixed a nasty and recurring issue with running gitlint in CI. Hopefully that's the end of it :-) (#40).
  • Fix for custom git comment characters (#48).

The 0.9.0 release adds a new default author-valid-email rule, important bugfixes and special case handling. Special thanks to joshholl, ron8mcr, omarkohl, domo141, nud and 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.
• Breaking change: The --commits commandline flag now strictly follows the refspec format as interpreted by the git rev-list <refspec> 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. This fixes #23.
• 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 and #42.
• Behavior Change: Gitlint will now by default ignore squash and fixup commits (fix for #33: fixup messages should not trigger a gitlint violation)
• Support for custom comment characters (#34)
• Support for git commit --cleanup=scissors (#34)
• Bugfix: #37: Prevent Commas in text fields from breaking git log printing
• Debug output improvements

The 0.8.2 release brings minor improvements, bugfixes and some under-the-hood changes. Special thanks to tommyip for his contributions.

• --extra-path now also accepts a file path (in the past only directory paths were accepted). Thanks to tommyip for implementing this!
• gitlint will now show more information when using the --debug flag. This is initial work and will continue to be improved upon in later releases.
• Bugfixes:
  • #24: --commits doesn't take commit specific config into account
  • #27: --commits returns the wrong exit code
• Development: better unit and integration test coverage for --commits

The 0.8.1 release brings minor tweaks and some experimental features. Special thanks to tommyip for his contributions.

• Experimental: Linting a range of commits. Documentation. Known Caveats: #23,#24. Closes #14. Thanks to tommyip for implementing this!
• Experimental: Python 3.6 support
• Improved Windows error messaging: gitlint will now show a more descriptive error message when ran on windows. See #20 for details on the lack of Windows support.

The 0.8.0 release is a significant release that has been in the works for a long time. Special thanks to Claymore, gernd and ZhangYaxu for submitting bug reports and pull requests.

• Full unicode support: you can now lint messages in any language! This fixes #16 and #18.
• User-defined rules: you can now define your own custom rules if you want to extend gitlint's functionality.
• Pypy2 support!
• Debug output improvements: Gitlint will now print your active configuration when using --debug
• The general.target option can now also be set via -c flags or a .gitlint file
• Bugfixes:
  • Various important fixes related to configuration precedence
  • #17: Body MinLength is not working properly. Behavior Change: Gitlint now always applies this rule, even if the body has just a single line of content. Also, gitlint now counts the body-length for the entire body, not just the length of the first line.
• Various documentation improvements
• Development:
  • Pylint compliance for all supported python versions
  • Updated dependencies to latest versions
  • Various run_tests.sh improvements for developer convenience

Bugfixes:

• Behavior change: gitlint no longer prints the file path by default when using a .gitlint file. The path will still be printed when using the new --debug flag. Special thanks to Slipcon for submitting this.
• Gitlint now prints a correct violation message for the title-match-regex rule. Special thanks to Slipcon for submitting this.
• Gitlint is now better at parsing commit messages cross-platform by taking platform specific line endings into account
• Minor documentation improvements

This release contains mostly bugfix and internal code improvements. Special thanks to William Turell and Joe Grund for bug reports and pull requests.

• commit-msg hooks improvements: The new commit-msg hook now allows you to edit your message if it contains violations, prints the commit message on aborting and is more compatible with GUI-based git clients such as SourceTree. You will need to uninstall and reinstall the commit-msg hook for these latest features.
• Python 2.6 support
• Behavior change: merge commits are now ignored by default. The rationale is that the original commits should already be linted and that many merge commits don't pass gitlint checks by default (e.g. exceeding title length or empty body is very common). This behavior can be overwritten by setting the general option ignore-merge-commit=false.
• Bugfixes and enhancements:
  • #7: Hook compatibility with SourceTree
  • #8: Illegal option -e
  • #9: print full commit msg to stdout if aborted
  • #11 merge commit titles exceeding the max title length by default
  • Better error handling of invalid general options
• Development: internal refactoring to extract more info from git. This will allow for more complex rules in the future.
• Development: initial set of integration tests. Test gitlint end-to-end after it is installed.
• Development: pylint compliance for python 2.7

• Fix: install-hook and generate-config commands not working when gitlint is installed from pypi.

• Python 3 (3.3+) support!
• All documentation is now hosted on http://jorisroovers.github.io/gitlint/
• New generate-config command generates a sample gitlint config file
• New --target flag allows users to lint different directories than the current working directory
• Breaking change: exit code behavior has changed. More details in the Exit codes section of the documentation.
• Breaking change: --install-hook and --uninstall-hook have been renamed to install-hook and uninstall-hook respectively to better express that they are commands instead of options.
• Better error handling when gitlint is executed in a directory that is not a git repository or when git is not installed.
• The git commit message hook now uses pretty colored output
• Fix: --config option no longer accepts directories as value
• Development: unit tests are now ran using py.test

• New Rule: title-match-regex. Details can be found in the Rules section of the documentation.
• Uninstall previously installed gitlint git commit hooks using: gitlint --uninstall-hook
• Ignore rules on a per commit basis by adding e.g.: gitlint-ignore: T1, body-hard-tab to your git commit message. Use gitlint-ignore: all to disable gitlint all together for a specific commit.
• body-is-missing will now automatically be disabled for merge commits (use the ignore-merge-commit: false option to disable this behavior)
• Violations are now sorted by line number first and then by rule id (previously the order of violations on the same line was arbitrary).

• Internal fix: added missing comma to setup.py which prevented pypi upload

• title-must-not-contain-word now has a words option that can be used to specify which words should not occur in the title
• gitlint violations are now printed to the stderr instead of stdout
• Various minor bugfixes
• gitlint now ignores commented out lines (i.e. starting with #) in your commit messages
• Experimental: git commit-msg hook support
• Under-the-hood: better test coverage :-)

• Rules can now have their behavior configured through options. For example, the title-max-length rule now has a line-length option.
• Under-the-hood: The codebase now has a basic level of unit test coverage, increasing overall quality assurance

• Bugfix: added missing sh dependency

• Initial gitlint release
• Initial set of rules: title-max-length, title-trailing-whitespace, title-trailing-punctuation , title-hard-tab, title-must-not-contain-word, body-max-line-length, body-trailing-whitespace, body-hard-tab
• General gitlint configuration through a gitlint file
• Silent and verbose mode
• Vagrantfile for easy development
• gitlint is available on pypi