Skip to content

chore: change pr-comments default to false and README.md #83

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 11, 2024
Merged

chore: change pr-comments default to false and README.md #83

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b000cc7
docs: update README.md
shenxianpeng Nov 11, 2024
69a8893
docs: Update README.md
shenxianpeng Nov 11, 2024
edb6081
chore: change pr-comments default value to false
shenxianpeng Nov 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,11 +85,12 @@ jobs:
### `pr-comments`

- **Description**: post results to the pull request comments
- Default: 'true'
- Default: 'false'

> [!IMPORTANT]
> This is a experimental feature
> 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)

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.

Expand Down Expand Up @@ -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)

Expand All @@ -140,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).
2 changes: 1 addition & 1 deletion action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down