Skip to content

Commit e7138ee

Browse files
authored
chore: change pr-comments default to false and README.md (#83)
* docs: update README.md * docs: Update README.md * chore: change pr-comments default value to false
1 parent 7102c90 commit e7138ee

File tree

2 files changed

+7
-6
lines changed

2 files changed

+7
-6
lines changed

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -85,11 +85,12 @@ jobs:
8585
### `pr-comments`
8686

8787
- **Description**: post results to the pull request comments
88-
- Default: 'true'
88+
- Default: 'false'
8989

9090
> [!IMPORTANT]
91-
> This is a experimental feature
92-
> use it you need to set `GITHUB_TOKEN` in the GitHub Action.
91+
> `pr-comments` is an experimental feature. To use it you need to set `GITHUB_TOKEN` in the GitHub Action.
92+
>
93+
> 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)
9394

9495
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.
9596

@@ -117,7 +118,7 @@ By default, commit-check-action results are shown on the job summary page of the
117118

118119
## Badging your repository
119120

120-
You can add a badge to your repository to show your contributors / users that you use commit-check!
121+
You can add a badge to your repository to show your contributors/users that you use commit-check!
121122

122123
[![Commit Check](https://github.com/commit-check/commit-check-action/actions/workflows/commit-check.yml/badge.svg)](https://github.com/commit-check/commit-check-action/actions/workflows/commit-check.yml)
123124

@@ -140,6 +141,6 @@ reStructuredText
140141
141142
Versioning follows [Semantic Versioning](https://semver.org/).
142143
143-
## Have question or feedback?
144+
## Have questions or feedback?
144145
145146
To provide feedback (requesting a feature or reporting a bug) please post to [issues](https://github.com/commit-check/commit-check/issues).

action.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ inputs:
3636
pr-comments:
3737
description: post results to the pull request comments
3838
required: false
39-
default: true
39+
default: false
4040
runs:
4141
using: "composite"
4242
steps:

0 commit comments

Comments
 (0)