Skip to content

Commit d8fc686

Browse files
authored
docs: Python 3.15 is supported, and bring the site to 2.18.1 (#44)
## What changes - **Python range:** commit-check 2.18.1 adds Python 3.15 to CI and to the package classifiers (commit-check/commit-check#583). The home page facts row, the FAQ and the getting-started tip now say **3.10 through 3.15**. - **FAQ correction:** it said CI "runs the suite on all five" versions. The version matrix in `main.yml` builds the wheel and installs it (`nox -s install`); the suite runs once. The answer now describes what the matrix does: 6 versions × 3 systems, 18 combinations. ## Docs sync - **Latest release:** 2.18.1 on PyPI, published 2026-09-24. - **Pins:** all four `rev:` pins move to `v2.18.1`. - **Changelog:** `docs/changelog.md` has a dated `v2.18.1` entry. No Highlights row: 2.18.1 only extends the supported Python range, with no new behaviour. - **Tests:** `python -m pytest tests/ -q` passes against the installed 2.18.1 (10 tests). - **Build:** `mkdocs build --strict` passes. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **New Features** * Added Python 3.15 support, with package builds and installation covered across Linux, macOS, and Windows. * **Documentation** * Updated supported Python version information and pre-commit examples for release 2.18.1. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
1 parent 0f41125 commit d8fc686

6 files changed

Lines changed: 17 additions & 8 deletions

File tree

‎docs/changelog.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,15 @@ below and to the page that documents the feature properly.
2929
| [2.5.0](#v250) | Organization-wide config with `inherit_from` | [Across an organization](guides/organization.md) |
3030
| [2.0.0](#v200) | Configuration moved from YAML to TOML — breaking | [Migrating from v1](migration.md) |
3131

32+
## v2.18.1 (2026-09-24) { #v2181 }
33+
34+
### Changed
35+
36+
* **Python 3.15 is supported.** CI now builds and installs the wheel on 3.15
37+
alongside 3.10–3.14, on Linux, macOS and Windows, and the package declares
38+
it. Contributed by [@itzzdev09](https://github.com/itzzdev09).
39+
See PR [#583](https://github.com/commit-check/commit-check/pull/583).
40+
3241
## v2.18.0 (2026-09-13) { #v2180 }
3342

3443
### Added

‎docs/configuration.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -239,7 +239,7 @@ Used from a hook definition, with no config file anywhere in the repository:
239239
```yaml title=".pre-commit-config.yaml"
240240
repos:
241241
- repo: https://github.com/commit-check/commit-check
242-
rev: v2.18.0
242+
rev: v2.18.1
243243
hooks:
244244
- id: check-message
245245
args:

‎docs/example.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ pushed:
131131
```yaml title=".pre-commit-config.yaml"
132132
repos:
133133
- repo: https://github.com/commit-check/commit-check
134-
rev: v2.18.0
134+
rev: v2.18.1
135135
hooks:
136136
- id: check-no-force-push
137137
stages: [pre-push]

‎docs/getting-started.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ name.
3636

3737
!!! tip "Supported Python versions"
3838

39-
Commit Check supports Python 3.10 through 3.14, on Linux, macOS and Windows.
39+
Commit Check supports Python 3.10 through 3.15, on Linux, macOS and Windows.
4040

4141
Running it as a [pre-commit hook](guides/pre-commit.md)
4242
or a [GitHub Action](guides/github-actions.md) needs no

‎docs/guides/pre-commit.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Add Commit Check to `.pre-commit-config.yaml`:
88
```yaml title=".pre-commit-config.yaml"
99
repos:
1010
- repo: https://github.com/commit-check/commit-check
11-
rev: v2.18.0
11+
rev: v2.18.1
1212
hooks:
1313
- id: check-message
1414
- id: check-branch
@@ -55,7 +55,7 @@ Options can be passed as hook arguments, which keeps everything in one file:
5555
```yaml title=".pre-commit-config.yaml"
5656
repos:
5757
- repo: https://github.com/commit-check/commit-check
58-
rev: v2.18.0
58+
rev: v2.18.1
5959
hooks:
6060
- id: check-message
6161
args:

‎docs/index.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ description: Catch bad commits before they merge. Messages, branches, authors an
6262
</div>
6363
<ul class="cc-wrap cc-facts">
6464
<li>MIT licensed, no account needed</li>
65-
<li>Python 3.10 – 3.14 on Linux, macOS and Windows</li>
65+
<li>Python 3.10 – 3.15 on Linux, macOS and Windows</li>
6666
<li>Signed build provenance on every release</li>
6767
<li>CLI and hook work with any Git host</li>
6868
</ul>
@@ -488,8 +488,8 @@ conventional_branch = <span class="cc-t-pass">true</span></div>
488488

489489
??? question "Which Python versions are supported?"
490490

491-
3.10 through 3.14. CI runs the suite on all five, across Linux, macOS and
492-
Windows — fifteen combinations on every change.
491+
3.10 through 3.15. On every change, CI builds the wheel and installs it on
492+
all six, across Linux, macOS and Windows — eighteen combinations.
493493

494494
??? question "How do I know the package I installed is the one you built?"
495495

0 commit comments

Comments
 (0)