Skip to content

Commit f8083f8

Browse files
committed
docs: add pr-title input documentation to README
1 parent 97cca51 commit f8083f8

1 file changed

Lines changed: 17 additions & 0 deletions

File tree

‎README.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,23 @@ jobs:
131131
> Note: write-access to pull-requests requires the `pull-requests: write` permission.
132132
> See [usage example](#usage).
133133

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+
134151
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.
135152

136153
## GitHub Action Job Summary

0 commit comments

Comments
 (0)