Skip to content

πŸ’¬ Automatically comment issues or PRs on events triggered

License

Notifications You must be signed in to change notification settings

wow-actions/auto-comment

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

48 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ’¬ Auto Comment

build MIT License Language PRs Welcome website Language grade: JavaScript

Automatically comment issues or PRs on events triggered.

πŸš€ Usage

Create a .github/workflows/auto-comment.yml file in the repository you want to install this action, then add the following to it:

name: Auto Comment
on: [issues, pull_request]
jobs:
  run:
    runs-on: ubuntu-latest
    steps:
      - uses: wow-actions/auto-comment@v1
        with:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          issuesOpened: |
            πŸ‘‹ @{{ author }}
            Thank you for raising an issue. We will will investigate into the matter and get back to you as soon as possible.
            Please make sure you have given us as much context as possible.

          pullRequestOpened: |
            πŸ‘‹ @{{ author }}
            Thank you for raising your pull request.
            Please make sure you have followed our contributing guidelines. We will review it as soon as possible

There are a couple of events that you will need to setup depending on what you want.

Available Events

  • issuesOpened
  • issuesEdited
  • issuesDeleted
  • issuesTransferred
  • issuesPinned
  • issuesUnpinned
  • issuesClosed
  • issuesReopened
  • issuesAssigned
  • issuesUnassigned
  • issuesLabeled
  • issuesUnlabeled
  • issuesLocked
  • issuesUnlocked
  • issuesMilestoned
  • issuesDemilestoned
  • pullRequestAssigned
  • pullRequestUnassigned
  • pullRequestLabeled
  • pullRequestUnlabeled
  • pullRequestEdited
  • pullRequestOpened
  • pullRequestClosed
  • pullRequestMerged
  • pullRequestReopened
  • pullRequestSynchronize
  • pullRequestReadyForReview
  • pullRequestLocked
  • pullRequestUnlocked
  • pullRequestReviewRequested
  • pullRequestReviewRequestRemoved

And we can also add reactions to comment with [eventName]Comment and [eventName]Reactions input. Available reactions:

content emoji
+1 πŸ‘
-1 πŸ‘Ž
laugh πŸ˜„
confused πŸ˜•
heart ❀️
hooray πŸŽ‰
rocket πŸš€
eyes πŸ‘€
name: Auto Comment
on: [issues, pull_request]
jobs:
  run:
    runs-on: ubuntu-latest
    steps:
      - uses: wow-actions/auto-comment@v1
        with:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          issuesOpenedReactions: 'hooray, +1'
          issuesOpenedComment: |
            πŸ‘‹ @{{ author }}
            Thank you for raising an issue. We will investigate into the matter and get back to you as soon as possible.
            Please make sure you have given us as much context as possible.

Available Placeholders

Name Description
{{ author }} The GitHub username of the person who opened the issue/pr
{{ id }} The numeric id of the issue/pr
{{ payload.* }} The payload of the issue/pr

πŸ”– License

The scripts and documentation in this project are released under the MIT License