From acf495bcd74ebe5bbf11bf91ac765277b4b21aee Mon Sep 17 00:00:00 2001 From: Edward McFarlane Date: Thu, 18 Jul 2024 21:53:35 +0200 Subject: [PATCH] Fix docs --- README.md | 2 +- action.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4e7210d..e4cabf8 100644 --- a/README.md +++ b/README.md @@ -72,7 +72,7 @@ Add these parameters under the `with` section of the `uses` step in the workflow | `paths` | Limit to specific files or directories (separated by newlines). | | | `exclude_imports` | Exclude files imported by the target modules. | False | | `exclude_paths` | Exclude specific files or directories, e.g. "proto/a/a.proto", "proto/a" (separated by newlines). | | -| `pr_comment` | Comment the results on the pull request. The `workflow / job` name must be unique. | Only on pull requests | +| `pr_comment` | Comment the results on the pull request. The workflow and job name combination must be unique. | Only on pull requests | | `format` | Whether to run the formatting step. | Runs on pushes to Git PR | | `lint` | Whether to run the linting step. | Runs on pushes to Git PR | | `breaking` | Whether to run the breaking change detection step. | Runs on pushes to Git PR | diff --git a/action.yml b/action.yml index 2ba22a6..2e074db 100644 --- a/action.yml +++ b/action.yml @@ -59,7 +59,7 @@ inputs: default: "false" pr_comment: description: |- - Comment on the pull request with the results of each step. + Comment on the pull request with the results of each step. The workflow and job name combination must be unique. required: false default: ${{ github.event_name == 'pull_request' }}