Skip to content

Commit 5e0d604

Browse files
committed
Changelog and README updates
- Updates Changelog for upcoming 0.16.0 release - Adds nicer image for the README
1 parent 7298237 commit 5e0d604

File tree

4 files changed

+22
-7
lines changed

4 files changed

+22
-7
lines changed

CHANGELOG.md

+14
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,19 @@
11
# Changelog #
22

3+
## v0.16.0 (2021-10-?) Soon! ##
4+
5+
Contributors:
6+
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).
7+
8+
- Python 3.10 support
9+
- **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
10+
- `--commit <SHA>` flag to more easily lint a single commit message ([#141](https://github.com/jorisroovers/gitlint/issues/141))
11+
- `--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))
12+
- Bugfixes:
13+
- [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))
14+
- [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))
15+
- 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.
16+
- Under-the-hood: dependencies updated, test and github action improvements.
317
## v0.15.1 (2021-04-16) ##
418

519
Contributors:

README.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,9 @@ Git commit message linter written in python (for Linux and Mac, experimental on
88

99
**See [jorisroovers.github.io/gitlint](http://jorisroovers.github.io/gitlint/) for full documentation.**
1010

11-
<a href="http://jorisroovers.github.io/gitlint/" target="_blank"><img src="https://asciinema.org/a/30477.png" width="640"/></a>
11+
<a href="http://jorisroovers.github.io/gitlint/" target="_blank">
12+
<img src="docs/images/readme-gitlint.png" />
13+
</a>
1214

1315
## Contributing ##
1416
All contributions are welcome and very much appreciated!

docs/images/readme-gitlint.png

340 KB
Loading

docs/index.md

+5-6
Original file line numberDiff line numberDiff line change
@@ -38,12 +38,11 @@ useful throughout the years.
3838
# Pip is recommended to install the latest version
3939
pip install gitlint
4040

41-
# macOS
42-
brew install gitlint
43-
sudo port install gitlint # alternative using macports
44-
45-
# Ubuntu
46-
apt-get install gitlint
41+
# Community maintained packages:
42+
brew install gitlint # Homebrew (macOS)
43+
sudo port install gitlint # Macports (macOS)
44+
apt-get install gitlint # Ubuntu
45+
# Other package managers, see https://repology.org/project/gitlint/versions
4746

4847
# Docker: https://hub.docker.com/r/jorisroovers/gitlint
4948
docker run --ulimit nofile=1024 -v $(pwd):/repo jorisroovers/gitlint

0 commit comments

Comments
 (0)