Skip to content

Latest commit

 

History

History
58 lines (44 loc) · 1.38 KB

README.md

File metadata and controls

58 lines (44 loc) · 1.38 KB

Comment

Actions Status

GitHub action to comment on PR, issue

Inputs

  • type: create, edit or delete
  • token: GitHub token
  • body: Comment body. Required with create and edit type.
  • comment_id: Comment id to edit body. Required with edit and delete type.
  • issue_number: Number of PR, issue to comment. Required with create type.

Outputs

  • id: Created or edited comment id. Empty string for delete.
  • body: Comment body. Empty string for delete.

Example

name: comment example
jobs:
  example:
    runs-on: ubuntu-latest
    steps:
      - name: Create comment
        uses: jungwinter/comment@v1
        id: create
        with:
          type: create
          body: "- [ ] Run tests"
          issue_number: '1'
          token: ${{ secrets.GITHUB_TOKEN }}

      - name: Update comment
        uses: jungwinter/comment@v1
        with:
          type: edit
          body: "- [x] Run tests"
          comment_id: ${{ steps.create.outputs.id }}
          token: ${{ secrets.GITHUB_TOKEN }}

      - name: Delete comment
        uses: jungwinter/comment@v1
        with:
          type: delete
          comment_id: ${{ steps.create.outputs.id }}
          token: ${{ secrets.GITHUB_TOKEN }}

MIT license