From b000cc71d832c9e592a673d7ba47b813f2245c7f Mon Sep 17 00:00:00 2001 From: shenxianpeng Date: Mon, 11 Nov 2024 23:55:25 +0200 Subject: [PATCH 1/3] docs: update README.md --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 53146a8..3674502 100644 --- a/README.md +++ b/README.md @@ -88,8 +88,9 @@ jobs: - Default: 'true' > [!IMPORTANT] -> This is a experimental feature -> use it you need to set `GITHUB_TOKEN` in the GitHub Action. +> This is an experimental feature. To use it you need to set `GITHUB_TOKEN` in the GitHub Action. +> +> 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) 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. @@ -117,7 +118,7 @@ By default, commit-check-action results are shown on the job summary page of the ## Badging your repository -You can add a badge to your repository to show your contributors / users that you use commit-check! +You can add a badge to your repository to show your contributors/users that you use commit-check! [![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) From 69a88931c86b16c501fe804d2b724705b35eccf6 Mon Sep 17 00:00:00 2001 From: shenxianpeng Date: Mon, 11 Nov 2024 23:58:12 +0200 Subject: [PATCH 2/3] docs: Update README.md --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 3674502..e58e79c 100644 --- a/README.md +++ b/README.md @@ -85,10 +85,10 @@ jobs: ### `pr-comments` - **Description**: post results to the pull request comments -- Default: 'true' +- Default: 'false' > [!IMPORTANT] -> This is an experimental feature. To use it you need to set `GITHUB_TOKEN` in the GitHub Action. +> `pr-comments` is an experimental feature. To use it you need to set `GITHUB_TOKEN` in the GitHub Action. > > 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) @@ -141,6 +141,6 @@ reStructuredText Versioning follows [Semantic Versioning](https://semver.org/). -## Have question or feedback? +## Have questions or feedback? To provide feedback (requesting a feature or reporting a bug) please post to [issues](https://github.com/commit-check/commit-check/issues). From edb6081b1288880d786485e1c6f0a275a975b633 Mon Sep 17 00:00:00 2001 From: shenxianpeng Date: Mon, 11 Nov 2024 23:59:20 +0200 Subject: [PATCH 3/3] chore: change pr-comments default value to false --- action.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/action.yml b/action.yml index 804f81c..531acb4 100644 --- a/action.yml +++ b/action.yml @@ -36,7 +36,7 @@ inputs: pr-comments: description: post results to the pull request comments required: false - default: true + default: false runs: using: "composite" steps: