diff --git a/README.md b/README.md index da0c58a..3830589 100644 --- a/README.md +++ b/README.md @@ -103,14 +103,34 @@ Some use cases might find the [find-comment](https://github.com/peter-evans/find This will search an issue or pull request for the first comment containing a specified string, and/or by a specified author. See the repository for detailed usage. +In the following example, find-comment is used to determine a comment has already been created on a pull request. In this case, the comment will be updated instead of being created. ```yml - - name: Find Comment - uses: peter-evans/find-comment@v1 - id: fc - with: - issue-number: 1 - comment-author: peter-evans - body-includes: search string 1 + - name: Find Comment + uses: peter-evans/find-comment@v1 + id: fc + with: + issue-number: ${{ github.event.pull_request.number }} #e.g. 1 + comment-author: 'github-actions[bot]' + body-includes: This comment was written by a bot! + + - name: Create comment + if: ${{ steps.fc.outputs.comment-id == 0 }} + uses: peter-evans/create-or-update-comment@v1 + with: + issue-number: ${{ github.event.pull_request.number }} + body: | + This comment was written by a bot! + reaction-type: "rocket" + + - name: Update comment + if: ${{ steps.fc.outputs.comment-id != 0 }} + uses: peter-evans/create-or-update-comment@v1 + with: + comment-id: ${{ steps.fc.outputs.comment-id }} + body: | + Update! + Comments can also be updated by us. :) + reaction-type: "rocket" ``` ### Setting the comment body from a file