Skip to content

Latest commit

 

History

History
75 lines (59 loc) · 2.31 KB

README.md

File metadata and controls

75 lines (59 loc) · 2.31 KB

😅 PR Welcome

Thanks for your contribution. But I maybe refuse.

How to use?

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 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
  • Can use v1 or v1.2.0

Changelog

CHANGELOG

Emoji List

content emoji
+1 👍
-1 👎
laugh 😄
confused 😕
heart ❤️
hooray 🎉
rocket 🚀
eyes 👀

LICENSE

MIT