https://github.com/actions-cool/pr-welcome
😅 Thanks for your contribution. But I maybe refuse.
https://github.com/actions-cool/pr-welcome
actions github-actions pull-request welcome
Last synced: 5 months ago
JSON representation
😅 Thanks for your contribution. But I maybe refuse.
- Host: GitHub
- URL: https://github.com/actions-cool/pr-welcome
- Owner: actions-cool
- License: mit
- Created: 2021-02-04T12:20:58.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-10-19T09:54:21.000Z (almost 4 years ago)
- Last Synced: 2025-05-06T17:47:55.200Z (5 months ago)
- Topics: actions, github-actions, pull-request, welcome
- Language: JavaScript
- Homepage:
- Size: 110 KB
- Stars: 6
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# 😅 PR Welcome
[](https://github.com/marketplace/actions/pr-welcome)
[](https://github.com/actions-cool/pr-welcome/releases)
Thanks for your contribution. But I maybe refuse.
## How to use?
```yml
name: PR Welcome
on:
pull_request_target:
types: [opened, edited, reopened]
jobs:
welcome:
runs-on: ubuntu-latest
steps:
- uses: actions-cool/pr-welcome@v1
with:
token: ${{ secrets.GITHUB_TOKEN }}
refuse-issue-label: 'xxx'
need-creator-authority: 'write'
comment: |
HI ~
你好~
emoji: '+1, -1, heart'
reviewers: 'user1, user2'
review-creator: false
close: true
```
| Name | Desc | Type | Required |
| -- | -- | -- | -- |
| token | GitHub token | string | ✖ |
| refuse-issue-label | Only when the label included in the issue mentioned in the PR is triggered | string | ✖ |
| need-creator-authority | Filter the permissions of the creator. Option: `read` `write` `admin` | string | ✖ |
| comment | Comment content after filter | string | ✖ |
| emoji | Comment [emoji](#emoji-list) | string | ✖ |
| pr-emoji | Add emoji to PR | string | ✖ |
| close | If close pr | boolean | ✖ |
| reviewers | Add reviewers to PR | string | ✖ |
| review-creator | If creator review. Default `true` | boolean | ✖ |
## Note
- When has `refuse-issue-label` or `need-creator-authority`, it will start filter mode
- Comment only once in a PR
- Triger event only support `pull_request` and `pull_request_target`. When use `pull_request`, the Action will only show the CI status icon(Because of permissions). When use `pull_request_target`, must [see](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#pull_request_target)
- Can use v1 or v1.2.0
## Changelog
[CHANGELOG](./CHANGELOG.md)
## Emoji List
| content | emoji |
| -- | -- |
| `+1` | 👍 |
| `-1` | 👎 |
| `laugh` | 😄 |
| `confused` | 😕 |
| `heart` | ❤️ |
| `hooray` | 🎉 |
| `rocket` | 🚀 |
| `eyes` | 👀 |
## LICENSE
[MIT](./LICENSE)