wow-actions / auto-comment

💬 Automatically comment issues or PRs on events triggered
MIT License
36 stars 13 forks source link
comment github-actions

💬 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

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