A GitHub action to create or update an issue or pull request comment
Go to file
2019-11-24 17:46:01 +09:00
.github/workflows Update workflow 2019-11-24 17:46:01 +09:00
dist Add action 2019-11-24 16:44:26 +09:00
.eslintrc.json Add action 2019-11-24 16:44:26 +09:00
.gitignore Add action 2019-11-24 16:44:26 +09:00
action.yml Update action.yml 2019-11-24 17:25:35 +09:00
index.js Add action 2019-11-24 16:44:26 +09:00
LICENSE Initial commit 2019-11-24 16:35:05 +09:00
package-lock.json Add action 2019-11-24 16:44:26 +09:00
package.json Add action 2019-11-24 16:44:26 +09:00
README.md Update README 2019-11-24 17:25:41 +09:00

Create or Update Comment

GitHub Marketplace

A GitHub action to create or update an issue or pull request comment.

This action was created to help facilitate a GitHub Actions "ChatOps" solution in conjunction with slash-command-dispatch action.

Usage

Add a comment to an issue or pull request

      - name: Create comment
        uses: peter-evans/create-or-update-comment@v1
        with:
          token: ${{ secrets.GITHUB_TOKEN }}
          issue-number: 1
          body: |
            This is a multi-line test comment
            - With GitHub **Markdown**
            - Created by [create-or-update-comment][1]

            [1]: https://github.com/peter-evans/create-or-update-comment            
          reaction-type: +1

Update a comment

      - name: Update comment
        uses: peter-evans/create-or-update-comment@v1
        with:
          token: ${{ secrets.GITHUB_TOKEN }}
          comment-id: 557858210
          body: |
            **Edit:** Some additional info            
          reaction-type: eyes

Add a comment reaction

      - name: Add reaction
        uses: peter-evans/create-or-update-comment@v1
        with:
          token: ${{ secrets.GITHUB_TOKEN }}
          comment-id: 557858210
          reaction-type: heart

Action inputs

Name Description Default
repository The full name of the repository in which to create or update a comment. Current repository
issue-number The number of the issue or pull request in which to create a comment.
comment-id The id of the comment to update.
body The comment body.
edit-mode The mode when updating a comment, replace or append. append
reaction-type The reaction to add to the comment. (+1, -1, laugh, confused, heart, hooray, rocket, eyes)

Accessing issues and comments in other repositories

You can create and update comments in another repository by using a PAT instead of GITHUB_TOKEN. The user associated with the PAT must have write access to the repository.

License

MIT