Skip to content

πŸ’– Welcomes new users by creating a comment in their first time issue/PR

License

Notifications You must be signed in to change notification settings

OrchardCMS/welcome-action

Β 
Β 

Repository files navigation

Welcome

build MIT License Language PRs Welcome website Language grade: JavaScript

Welcome new users by creating a comment in the first time issue/PR

first-issue

Usage

Create a .github/workflows/welcome.yml file in the repository you want to install this action, then add the following to it:

name: Welcome
on:
  pull_request:
    types: [opened, closed]
  issues:
    types: [opened]
jobs:
  run:
    runs-on: ubuntu-latest
    steps:
      - uses: wow-actions/welcome@v1
        with:
          FIRST_ISSUE: |
            πŸ‘‹ @{{ author }}
             Thanks for opening your first issue here! Be sure to follow the issue template!

          FIRST_PR: |
            πŸ‘‹ @{{ author }}
            Thanks for opening this pull request! Please check out our contributing guidelines.

          FIRST_PR_MERGED: |
            πŸŽ‰ @{{ author }}
            Congrats on merging your first pull request! We here at behaviorbot are proud of you!

          STAR_MESSAGE: If you like this project, please ⭐star⭐ our repo.

Inputs

Various inputs are defined to let you configure the action:

Note: Workflow command and parameter names are not case-sensitive.

Name Description Default
GITHUB_TOKEN The GitHub token for authentication. ${{ github.token }}
FIRST_ISSUE
or
FIRST_ISSUE_COMMENT
Comment to be posted to on first time issues.
FIRST_ISSUE_REACTIONS Reactions to be add to comment on first time issues.
FIRST_PR
or
FIRST_PR_COMMENT
Comment to be posted to on PRs from first time contributors in your repository.
FIRST_PR_REACTIONS Reactions to be add to comment on PRs from first time contributors in your repository.
FIRST_PR_MERGED
or
FIRST_PR_MERGED_COMMENT
Comment to be posted to on pull requests merged by a first time user.
FIRST_PR_MERGED_REACTIONS Reactions to be add to comment on pull requests merged by a first time user.
STAR_MESSAGE Message in the comment to tip non-stargazers to star our repo.

Available reactions:

content emoji
+1 πŸ‘
-1 πŸ‘Ž
laugh πŸ˜„
confused πŸ˜•
heart ❀️
hooray πŸŽ‰
rocket πŸš€
eyes πŸ‘€

Other examples

Config for First Issue

name: Welcome
on:
  issues:
    types: [opened]
jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: wow-actions/welcome@v1
        with:
          FIRST_ISSUE_REACTIONS: '+1, hooray, rocket, heart'
          FIRST_ISSUE_COMMENT: |
            πŸ‘‹ @{{ author }}
             Thanks for opening your first issue here! Be sure to follow the issue template!

Config for First PR

name: Welcome
on:
  pull_request:
    types: [opened]
jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: wow-actions/welcome@v1
        with:
          FIRST_PR_REACTIONS: '+1, hooray, rocket, heart'
          FIRST_PR_COMMENT: |
            πŸ‘‹ @{{ author }}
            Thanks for opening this pull request! Please check out our contributing guidelines.

License

The scripts and documentation in this project are released under the MIT License

About

πŸ’– Welcomes new users by creating a comment in their first time issue/PR

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 97.2%
  • Shell 2.8%