Welcome new users by creating a comment in the first time issue/PR
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.
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 |
π |
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!
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.
The scripts and documentation in this project are released under the MIT License