https://github.com/awcodify/comment-finder
Find Comments in PR
https://github.com/awcodify/comment-finder
Last synced: 4 months ago
JSON representation
Find Comments in PR
- Host: GitHub
- URL: https://github.com/awcodify/comment-finder
- Owner: awcodify
- License: mit
- Created: 2024-04-25T07:57:28.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-09T09:38:34.000Z (10 months ago)
- Last Synced: 2025-02-25T01:37:33.293Z (4 months ago)
- Language: JavaScript
- Homepage:
- Size: 1.22 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# Comment Finder
[](https://github.com/super-linter/super-linter)
This GitHub Action checks if a specific user or team member has commented on the
current PR with given keywords.The action can be useful in various scenarios, such as:
- Enforcing code review policies by requiring specific users or team members to
approve changes before merging.
- Automating deployment processes by ensuring that the necessary approvals have
been obtained.
- Implementing custom workflows based on comment patterns or specific user
interactions.## Usage
```yaml
name: Comment Finder
on:
pull_request:
types: [opened, synchronize, reopened, closed]
paths-ignore:
- '**.md'jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Check for comments
uses: awcodify/comment-finder@v1
with:
authors: 'username1,username2'
keywords: 'approve,yes,LGTM'
token: ${{ secrets.GITHUB_TOKEN }}
```## Inputs
- **authors**: GitHub usernames or team slugs separated by commas. This will be
used to filter comments by the author. If the author is a team, use the format
`team/{{team-name}}`.
- **keywords**: Comment keywords to search for (comma-separated). For instance:
`approve,yes,LGTM`.
- **token**: GitHub token.
- **fail_on_mismatch**: Fail the action if the given keywords are not found in
the comments
- **include_review_comments**: This will allow use to search comment from pull
request review## Outputs
- **matching_authors**: This will show authors which commented using given
keyword in the PR.