Skip to content
terminal

GitHub Action

PR Welcome

v1.4.0 Latest version

PR Welcome

terminal

PR Welcome

Thanks for your contribution. πŸ˜… But I refuse

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: PR Welcome

              
  uses: actions-cool/pr-welcome@v1.4.0
Learn more about this action in actions-cool/pr-welcome

Choose a version

πŸ˜… 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