- Notifications
You must be signed in to change notification settings - Fork68
A GitHub action to find an issue or pull request comment
License
peter-evans/find-comment
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
A GitHub action to find an issue or pull request comment.
The action will output the comment ID of the comment matching the search criteria.
-name:Find Commentuses:peter-evans/find-comment@v3id:fcwith:issue-number:1body-includes:search string 1
-name:Find Commentuses:peter-evans/find-comment@v3id:fcwith:issue-number:1comment-author:peter-evans
-name:Find Commentuses:peter-evans/find-comment@v3id:fcwith:issue-number:1comment-author:peter-evansbody-includes:search string 1
-name:Find Commentuses:peter-evans/find-comment@v3id:fcwith:issue-number:1body-regex:'^.*search string 1.*$'
-name:Find Commentuses:peter-evans/find-comment@v3id:fcwith:issue-number:1body-includes:search string 1direction:last
-name:Find Commentuses:peter-evans/find-comment@v3id:fcwith:issue-number:1body-includes:search string 1nth:1# second matching comment (0-indexed)
| Name | Description | Default |
|---|---|---|
token | GITHUB_TOKEN or arepo scopedPAT. | GITHUB_TOKEN |
repository | The full name of the repository containing the issue or pull request. | github.repository (Current repository) |
issue-number | The number of the issue or pull request in which to search. | |
comment-author | The GitHub user name of the comment author. | |
body-includes | A string to search for in the body of comments. | |
body-regex | A regular expression to search for in the body of comments. | |
direction | Search direction, specified asfirst orlast | first |
nth | 0-indexed number, specifying which comment to return if multiple are found | 0 |
Thecomment-id,comment-node-id,comment-body,comment-author andcomment-created-at of the matching comment found will be output for use in later steps.They will be empty strings if no matching comment was found.Note that in order to read the step outputs the action step must have an id.
Tip: Empty strings evaluate to zero in GitHub Actions expressions.e.g. Ifcomment-id is an empty stringsteps.fc.outputs.comment-id == 0 evaluates totrue.
-name:Find Commentuses:peter-evans/find-comment@v3id:fcwith:issue-number:1body-includes:search string 1 -run:| echo ${{ steps.fc.outputs.comment-id }} echo ${{ steps.fc.outputs.comment-node-id }} echo ${{ steps.fc.outputs.comment-body }} echo ${{ steps.fc.outputs.comment-author }} echo ${{ steps.fc.outputs.comment-created-at }}
You can search the comments of issues and pull requests in another repository by using aPAT instead ofGITHUB_TOKEN.
About
A GitHub action to find an issue or pull request comment