https://github.com/wow-actions/welcome
💖 Welcomes new users by creating a comment in their first time issue/PR
https://github.com/wow-actions/welcome
github-actions welcome
Last synced: 3 months ago
JSON representation
💖 Welcomes new users by creating a comment in their first time issue/PR
- Host: GitHub
- URL: https://github.com/wow-actions/welcome
- Owner: wow-actions
- License: mit
- Created: 2020-09-24T07:29:48.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-10-18T07:54:54.000Z (12 months ago)
- Last Synced: 2025-06-08T14:02:57.722Z (4 months ago)
- Topics: github-actions, welcome
- Language: TypeScript
- Homepage:
- Size: 1.26 MB
- Stars: 9
- Watchers: 1
- Forks: 5
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Welcome
Welcome new users by creating a comment in the first time issue/PR
## Usage
Create a `.github/workflows/welcome.yml` file in the repository you want to install this action, then add the following to it:
```yml
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](https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-commands-for-github-actions#about-workflow-commands).
| 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
```yml
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
```yml
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](LICENSE)