Skip to content

Commit b74de65

Browse files
committed
update readme.md
1 parent 4b588d1 commit b74de65

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,10 @@ jobs:
8181
- **Description**: post results to the pull request comments
8282
- Default: 'true'
8383

84+
> [!IMPORTANT]
85+
> This is a experimental feature
86+
> use it you need to set `GITHUB_TOKEN` in the GitHub Action.
87+
8488
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.
8589

8690
## GitHub Action job summary
@@ -95,6 +99,12 @@ By default, commit-check-action results are shown on the job summary page of the
9599

96100
![Failure job summary](https://github.com/commit-check/.github/blob/main/screenshot/failure-summary.png)
97101

102+
## GitHub Pull Request comments
103+
104+
### Success pull request comment
105+
106+
![Success pull request comment](https://github.com/commit-check/.github/blob/main/screenshot/success-pr-comments.png)
107+
98108
## Badging your repository
99109

100110
You can add a badge to your repository to show your contributors / users that you use commit-check!

0 commit comments

Comments
 (0)