diff options
-rw-r--r-- | CHANGELOG.md | 15 | ||||
-rw-r--r-- | docs/configuration.md | 19 | ||||
-rw-r--r-- | docs/contributing.md | 5 | ||||
-rw-r--r-- | docs/index.md | 6 | ||||
-rw-r--r-- | docs/rules.md | 4 | ||||
-rw-r--r-- | mkdocs.yml | 1 | ||||
-rw-r--r-- | setup.py | 6 |
7 files changed, 39 insertions, 17 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md index 44de09d..141a2d8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,9 +1,22 @@ # Changelog # +## v0.15.0 (TBD) ## + +Contributors: +Special thanks to [BrunIF](https://github.com/BrunIF), [lukech](https://github.com/lukech), [Cielquan](https://github.com/Cielquan), [harens](https://github.com/harens) and [sigmavirus24](https://github.com/sigmavirus24). + +**This release drops support for Python 2.7 and Python 3.5 ([both are EOL](https://endoflife.date/python)). 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](https://github.com/harens) for maintaining these packages (best-effort). +- Bugfix: Gitlint now properly handles exceptions when using its built-in commit-msg hook ([#166](https://github.com/jorisroovers/gitlint/issues/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 + ## v0.14.0 (2020-10-24) ## Contributors: -Special thanks to all contributors for this release, in particular [@mrshu](https://github.com/mrshu), [@glasserc](https://github.com/glasserc), [@strk](https://github.com/strk), [@chgl](https://github.com/chgl), [@melg8](https://github.com/melg8) and [@sigmavirus24](https://github.com/sigmavirus24). +Special thanks to all contributors for this release, in particular [mrshu](https://github.com/mrshu), [glasserc](https://github.com/glasserc), [strk](https://github.com/strk), [chgl](https://github.com/chgl), [melg8](https://github.com/melg8) and [sigmavirus24](https://github.com/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](https://endoflife.date/python) which makes it difficult to keep supporting them.** diff --git a/docs/configuration.md b/docs/configuration.md index 78224c1..50c4e63 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -80,7 +80,7 @@ min-length=5 words=wip [title-match-regex] -# python like regex (https://docs.python.org/2/library/re.html) that the +# python like regex (https://docs.python.org/3/library/re.html) that the # commit-msg title must be matched to. # Note that the regex can contradict with other rules if not used correctly # (e.g. title-must-not-contain-word). @@ -100,8 +100,8 @@ ignore-merge-commits=false [body-changed-file-mention] # List of files that need to be explicitly mentioned in the body when they are changed # This is useful for when developers often erroneously edit certain files or git submodules. -# By specifying this rule, developers can only change the file when they explicitly reference -# it in the commit message. +# By specifying this rule, developers can only change the file when they explicitly +# reference it in the commit message. files=gitlint/rules.py,README.md [body-match-regex] @@ -110,9 +110,10 @@ files=gitlint/rules.py,README.md regex=My-Commit-Tag: foo$ [author-valid-email] -# python like regex (https://docs.python.org/2/library/re.html) that the +# python like regex (https://docs.python.org/3/library/re.html) that the # commit author email address should be matched to -# E.g.: For example, use the following regex if you only want to allow email addresses from foo.com +# E.g.: For example, use the following regex if you only want to allow email +# addresses from foo.com regex=[^@]+@foo.com [ignore-by-title] @@ -330,8 +331,10 @@ Default value | gitlint version | commandline flag | environment ```sh # CLI gitlint --contrib=contrib-title-conventional-commits,CC1 -gitlint -c general.contrib=contrib-title-conventional-commits,CC1 # different way of doing the same -GITLINT_CONTRIB=contrib-title-conventional-commits,CC1 gitlint # using env variable +# different way of doing the same +gitlint -c general.contrib=contrib-title-conventional-commits,CC1 +# using env variable +GITLINT_CONTRIB=contrib-title-conventional-commits,CC1 gitlint ``` ```ini #.gitlint @@ -341,7 +344,7 @@ contrib=contrib-title-conventional-commits,CC1 ### staged -Fetch additional meta-data from the local `repository when manually passing a commit message to gitlint via stdin or `--commit-msg`. +Fetch additional meta-data from the local repository when manually passing a commit message to gitlint via stdin or `--commit-msg`. Default value | gitlint version | commandline flag | environment variable ---------------|------------------|-------------------|----------------------- diff --git a/docs/contributing.md b/docs/contributing.md index 942fd71..e58378c 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -34,7 +34,8 @@ 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. +There is a Vagrantfile (Ubuntu) in this repository that can be used for development. +It comes pre-installed with all Python versions that gitlint supports. ```sh vagrant up vagrant ssh @@ -51,7 +52,7 @@ python setup.py develop To run tests: ```sh ./run_tests.sh # run unit tests and print test coverage -./run_test.sh gitlint/tests/test_body_rules.py::BodyRuleTests::test_body_missing # run a single test +./run_tests.sh gitlint/tests/rules/test_body_rules.py::BodyRuleTests::test_body_missing # run a single test ./run_tests.sh --no-coverage # run unit tests without test coverage ./run_tests.sh --collect-only --no-coverage # Only collect, don't run unit tests ./run_tests.sh --integration # Run integration tests (requires that you have gitlint installed) diff --git a/docs/index.md b/docs/index.md index ba04433..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 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).** + **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). @@ -40,7 +40,7 @@ pip install gitlint # macOS brew install gitlint -sudo port install gitlint # alternative +sudo port install gitlint # alternative using macports # Ubuntu apt-get install gitlint @@ -224,7 +224,7 @@ your `.pre-commit-config.yaml` file like so: !!! important - You need to add `--msg-filename` at the end of your custom `args` list as the gitlint-hook will fail otherwise. + 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 diff --git a/docs/rules.md b/docs/rules.md index 178f962..23b8e91 100644 --- a/docs/rules.md +++ b/docs/rules.md @@ -255,8 +255,8 @@ files | >= 0.4 | (empty) | Comma-separated list o #### .gitlint ```ini -# Prevent that certain sensitive files are committed by mistake by forcing users to mention them explicitly if they're -# deliberately changing them +# Prevent that certain sensitive files are committed by mistake by forcing +# users to mention them explicitly if they're deliberately changing them [body-changed-file-mention] files=generated.xml,secrets.txt,private-key.pem ``` @@ -2,6 +2,7 @@ site_name: Gitlint site_description: Linting for your git commit messages site_url: http://jorisroovers.github.io/gitlint/ repo_url: https://github.com/jorisroovers/gitlint +edit_uri: edit/main/docs nav: - Home: index.md - Configuration: configuration.md @@ -69,7 +69,11 @@ setup( }, keywords='gitlint git lint', author='Joris Roovers', - url='https://github.com/jorisroovers/gitlint', + url='https://jorisroovers.github.io/gitlint', + project_urls={ + 'Documentation': 'https://jorisroovers.github.io/gitlint', + 'Source': 'https://github.com/jorisroovers/gitlint', + }, license='MIT', package_data={ 'gitlint': ['files/*'] |