Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wow-actions/auto-comment
💬 Automatically comment issues or PRs on events triggered
https://github.com/wow-actions/auto-comment
comment github-actions
Last synced: 1 day ago
JSON representation
💬 Automatically comment issues or PRs on events triggered
- Host: GitHub
- URL: https://github.com/wow-actions/auto-comment
- Owner: wow-actions
- License: mit
- Created: 2020-09-24T12:17:06.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2022-12-16T07:57:07.000Z (almost 2 years ago)
- Last Synced: 2024-11-14T04:05:11.843Z (6 days ago)
- Topics: comment, github-actions
- Language: TypeScript
- Homepage:
- Size: 537 KB
- Stars: 36
- Watchers: 3
- Forks: 13
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
💬 Auto Comment
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:
```yml
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` | 👀 |
```yml
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](https://docs.github.com/cn/rest/pulls/pulls#get-a-pull-request) |
## 🔖 License
The scripts and documentation in this project are released under the [MIT License](LICENSE)