Skip to content

Commit d36e878

Browse files
authored
docs: update README.md
1 parent eb895f4 commit d36e878

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,14 @@ A GitHub Action for checking commit message formatting, branch naming, committer
1111
## What's New in v2
1212

1313
> [!IMPORTANT]
14-
> This v2 release introduces several **breaking changes**. Please review the [Breaking Changes](#breaking-changes) section before upgrading.
14+
> This v2 release introduces several 🚨**breaking changes**. Please review the [Breaking Changes](#breaking-changes) section carefully before upgrading.
1515
1616
### Breaking Changes
1717

18-
- Dropped support for `commit-signoff`, `merge-base`, and `imperative` inputs which are moved to new config file `commit-check.toml`.
19-
- Dropped support for `.commit-check.yml` in favor of `commit-check.toml`.
20-
- Changed default values of `author-name` and `author-email` inputs to `false` to align with commit-check default configuration.
21-
- Updated core dependency [`commit-check`](https://github.com/commit-check/commit-check) to [**v2.0.0**](https://github.com/commit-check/commit-check/releases/tag/v2.0.0).
18+
- Removed support for `commit-signoff`, `merge-base`, and `imperative` inputs — now configured via `commit-check.toml` or `cchk.toml`.
19+
- Deprecated `.commit-check.yml` in favor of `commit-check.toml` or `cchk.toml`.
20+
- Changed default values of `author-name` and `author-email` inputs to `false` to align with the default behavior in commit-check.
21+
- Upgraded core dependency [`commit-check`](https://github.com/commit-check/commit-check) to [**v2.0.0**](https://github.com/commit-check/commit-check/releases/tag/v2.0.0).
2222

2323
## Table of Contents
2424

0 commit comments

Comments
 (0)