Skip to content

Commit 2d5dfe0

Browse files
committed
feat!: change default values and update docs
1 parent 4e5410a commit 2d5dfe0

File tree

2 files changed

+29
-13
lines changed

2 files changed

+29
-13
lines changed

README.md

Lines changed: 25 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,24 @@
88

99
A GitHub Action for checking commit message formatting, branch naming, committer name, email, commit signoff, and more.
1010

11+
## What's New?
12+
13+
> [!NOTE]
14+
> **Version:** `v2.0.0`*2025-10-20*
15+
16+
> [!IMPORTANT]
17+
> This release introduces several **breaking changes**. Please review the [Breaking Changes](#breaking-changes) section before upgrading.
18+
19+
### Breaking Changes
20+
21+
- Dropped support for `commit-signoff`, `merge-base`, and `imperative` inputs which are moved to new config file `commit-check.toml`.
22+
- Dropped support for `.commit-check.yml` in favor of `commit-check.toml`.
23+
- Changed default values of `author-name` and `author-email` inputs to `false` to align with commit-check default configuration.
24+
- Updated core dependency [`commit-check`](https://github.com/commit-check/commit-check) to **v2.0.0**.
25+
26+
> [!TIP]
27+
> For migration guidance, see the [v2.0.0 Upgrade Guide](https://commit-check.github.io/commit-check/migration.html).
28+
1129
## Table of Contents
1230

1331
* [Usage](#usage)
@@ -46,8 +64,8 @@ jobs:
4664
with:
4765
message: true
4866
branch: true
49-
author-name: true
50-
author-email: true
67+
author-name: false
68+
author-email: false
5169
job-summary: true
5270
pr-comments: ${{ github.event_name == 'pull_request' }}
5371
```
@@ -78,25 +96,23 @@ jobs:
7896
7997
### `message`
8098

81-
- **Description**: check commit message formatting convention.
82-
- By default, the rule follows [Conventional Commits](https://www.conventionalcommits.org/).
99+
- **Description**: check git commit message following [Conventional Commits](https://www.conventionalcommits.org/).
83100
- Default: `true`
84101

85102
### `branch`
86103

87-
- **Description**: check git branch naming convention.
88-
- By default, the rule follows [Conventional Branch](https://conventional-branch.github.io/).
104+
- **Description**: check git branch name following [Conventional Branch](https://conventional-branch.github.io/).
89105
- Default: `true`
90106

91107
### `author-name`
92108

93109
- **Description**: check committer author name.
94-
- Default: `true`
110+
- Default: `false`
95111

96112
### `author-email`
97113

98114
- **Description**: check committer author email.
99-
- Default: `true`
115+
- Default: `false`
100116

101117
### `dry-run`
102118

@@ -118,7 +134,7 @@ jobs:
118134
>
119135
> This feature currently doesn’t work with forked repositories. For more details, refer to issue [#77](https://github.com/commit-check/commit-check-action/issues/77).
120136

121-
Note: the default rule of above inputs is following [this configuration](https://github.com/commit-check/commit-check/blob/main/.commit-check.yml). If you want to customize, just add your `.commit-check.yml` config file under your repository root directory.
137+
Note: the default rule of above inputs is following [this configuration](https://github.com/commit-check/commit-check-action/blob/main/commit-check.toml). If you want to customize, just add your [`commit-check.toml`](https://commit-check.github.io/commit-check/configuration.html) config file under your repository root directory.
122138

123139
## GitHub Action Job Summary
124140

action.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,21 @@ branding:
66
color: "blue"
77
inputs:
88
message:
9-
description: check commit message formatting convention
9+
description: check git commit message following conventional commits
1010
required: false
1111
default: true
1212
branch:
13-
description: check git branch naming convention
13+
description: check git branch name following conventional branch
1414
required: false
1515
default: true
1616
author-name:
1717
description: check committer author name
1818
required: false
19-
default: true
19+
default: false
2020
author-email:
2121
description: check committer author email
2222
required: false
23-
default: true
23+
default: false
2424
dry-run:
2525
description: run checks without failing
2626
required: false

0 commit comments

Comments
 (0)