11# First Interaction
22
3- An action for filtering pull requests and issues from first-time contributors.
3+ [ ![ Super-Linter] ( https://github.com/actions/first-interaction/actions/workflows/linter.yml/badge.svg )] ( https://github.com/super-linter/super-linter )
4+ ![ CI] ( https://github.com/actions/first-interaction/actions/workflows/ci.yml/badge.svg )
5+ [ ![ Check dist/] ( https://github.com/actions/first-interaction/actions/workflows/check-dist.yml/badge.svg )] ( https://github.com/actions/first-interaction/actions/workflows/check-dist.yml )
6+ [ ![ CodeQL] ( https://github.com/actions/first-interaction/actions/workflows/codeql-analysis.yml/badge.svg )] ( https://github.com/actions/first-interaction/actions/workflows/codeql-analysis.yml )
7+ [ ![ Coverage] ( ./badges/coverage.svg )] ( ./badges/coverage.svg )
8+
9+ An action for filtering pull requests (PRs) and issues from first-time
10+ contributors.
11+
12+ When a first-time contributor opens a PR or issue, this action will add a
13+ comment to the PR or issue with a message of your choice. This action is useful
14+ for welcoming first-time contributors to your project and providing them with
15+ information about how to contribute effectively.
416
517## Usage
618
@@ -9,23 +21,32 @@ See [action.yml](action.yml)
921``` yaml
1022name : Greetings
1123
12- on : [pull_request, issues]
24+ on :
25+ pull_request :
26+ types :
27+ - opened
28+ issues :
29+ types :
30+ - opened
31+
32+ permissions :
33+ issues : write
34+ pull-requests : write
1335
1436jobs :
1537 greeting :
38+ name : Greet First-Time Contributors
1639 runs-on : ubuntu-latest
40+
1741 steps :
18- - uses : actions/first-interaction@v1
19- with :
20- repo-token : ${{ secrets.GITHUB_TOKEN }}
21- issue-message : |
22- # Message with markdown.
23- This is the message that will be displayed on users' first issue.
24- pr-message : |
25- Message that will be displayed on users' first pr.
26- Look, a `code block` for markdown.
27- ` ` `
42+ - uses : actions/first-interaction@vX.Y.Z # Set this to the latest release
43+ with :
44+ issue-message : |
45+ # Issue Message with Markdown
2846
29- ## License
47+ This is the message that will be displayed!
48+ pr-message : |
49+ # PR Message with Markdown
3050
31- The scripts and documentation in this project are released under the [MIT License](LICENSE)
51+ This is the message that will be displayed!
52+ ` ` `
0 commit comments