summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJoris Roovers <joris.roovers@gmail.com>2021-10-08 14:40:29 +0200
committerJoris Roovers <joris.roovers@gmail.com>2021-10-08 14:54:13 +0200
commit5e0d604c730a7a20d73a559201d3f76826bd1026 (patch)
tree29109665c236a5c4df365d3d87637bcedbfdb7a0
parent72982374a9f0b680359e152d01ed61fd54d68b2c (diff)
Changelog and README updates
- Updates Changelog for upcoming 0.16.0 release - Adds nicer image for the README
-rw-r--r--CHANGELOG.md14
-rw-r--r--README.md4
-rw-r--r--docs/images/readme-gitlint.pngbin0 -> 348007 bytes
-rw-r--r--docs/index.md11
4 files changed, 22 insertions, 7 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md
index bb72596..96355e8 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,5 +1,19 @@
# Changelog #
+## v0.16.0 (2021-10-?) Soon! ##
+
+Contributors:
+Special thanks to all contributors for this release, in particular [sigmavirus24](https://github.com/sigmavirus24), [l0b0](https://github.com/l0b0) and [rafaelbubach](https://github.com/rafaelbubach).
+
+- Python 3.10 support
+- **New Rule**: [ignore-by-author-name](http://jorisroovers.github.io/gitlint/rules/#i4-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](https://github.com/jorisroovers/gitlint/issues/141))
+- `--fail-without-commits` flag will force gitlint to fail ([exit code 253](https://jorisroovers.com/gitlint/#exit-codes)) when the target commit range is empty (typically when using `--commits`) ([#193](https://github.com/jorisroovers/gitlint/issues/193))
+- Bugfixes:
+ - [contrib-title-conventional-commits (CT1)](https://jorisroovers.com/gitlint/contrib_rules/#ct1-contrib-title-conventional-commits) now properly enforces the commit type ([#185](https://github.com/jorisroovers/gitlint/issues/185))
+ - [contrib-title-conventional-commits (CT1)](https://jorisroovers.com/gitlint/contrib_rules/#ct1-contrib-title-conventional-commits) now supports the BREAKING CHANGE symbol "!" ([#186](https://github.com/jorisroovers/gitlint/issues/186))
+- Heads-up: [Python 3.6 will become EOL at the end of 2021](https://endoflife.date/python). 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.
## v0.15.1 (2021-04-16) ##
Contributors:
diff --git a/README.md b/README.md
index 273cdd4..e87dc37 100644
--- a/README.md
+++ b/README.md
@@ -8,7 +8,9 @@ Git commit message linter written in python (for Linux and Mac, experimental on
**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>
+<a href="http://jorisroovers.github.io/gitlint/" target="_blank">
+<img src="docs/images/readme-gitlint.png" />
+</a>
## Contributing ##
All contributions are welcome and very much appreciated!
diff --git a/docs/images/readme-gitlint.png b/docs/images/readme-gitlint.png
new file mode 100644
index 0000000..516c915
--- /dev/null
+++ b/docs/images/readme-gitlint.png
Binary files differ
diff --git a/docs/index.md b/docs/index.md
index 3eb00a5..98b72de 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -38,12 +38,11 @@ useful throughout the years.
# Pip is recommended to install the latest version
pip install gitlint
-# macOS
-brew install gitlint
-sudo port install gitlint # alternative using macports
-
-# Ubuntu
-apt-get install gitlint
+# Community maintained packages:
+brew install gitlint # Homebrew (macOS)
+sudo port install gitlint # Macports (macOS)
+apt-get install gitlint # Ubuntu
+# Other package managers, see https://repology.org/project/gitlint/versions
# Docker: https://hub.docker.com/r/jorisroovers/gitlint
docker run --ulimit nofile=1024 -v $(pwd):/repo jorisroovers/gitlint