You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit f8083f8
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: README.md
+17Lines changed: 17 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -131,6 +131,23 @@ jobs:
131
131
> Note: write-access to pull-requests requires the `pull-requests: write` permission.
132
132
> See [usage example](#usage).
133
133
134
+
### `pr-title`
135
+
136
+
- **Description**: check pull request title following [Conventional Commits](https://www.conventionalcommits.org/).
137
+
- Default: `false`
138
+
139
+
> [!TIP]
140
+
> This is especially useful for teams using **Squash & Merge**, where the PR title
141
+
> becomes the final commit message in the main branch. When enabled, the action
142
+
> validates the PR title against your Conventional Commits configuration, giving
143
+
> early feedback at PR time rather than after merge.
144
+
>
145
+
> `pr-title` works alongside `message` — you can enable both to validate the PR
146
+
> title and individual commits, or just one depending on your workflow.
147
+
>
148
+
> This setting only applies to `pull_request` and `pull_request_target` events;
149
+
> it is silently ignored on `push` events.
150
+
134
151
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.
0 commit comments