Merge pull request #36 from tacaswell/doc_complete_example
DOC: adjust the example to show a full yaml file
This commit is contained in:
19
README.md
19
README.md
@@ -7,12 +7,19 @@ An action for filtering pull requests and issues from first-time contributors.
|
||||
See [action.yml](action.yml)
|
||||
|
||||
```yaml
|
||||
steps:
|
||||
- uses: actions/first-interaction@v1
|
||||
with:
|
||||
repo-token: ${{ secrets.GITHUB_TOKEN }}
|
||||
issue-message: '# Message with markdown.\nThis is the message that will be displayed on users first issue.'
|
||||
pr-message: 'Message that will be displayed on users first pr. Look, a `code block` for markdown.'
|
||||
name: Greetings
|
||||
|
||||
on: [pull_request, issues]
|
||||
|
||||
jobs:
|
||||
greeting:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/first-interaction@v1
|
||||
with:
|
||||
repo-token: ${{ secrets.GITHUB_TOKEN }}
|
||||
issue-message: 'Message that will be displayed on users first issue'
|
||||
pr-message: 'Message that will be displayed on users first pr'
|
||||
```
|
||||
|
||||
# License
|
||||
|
||||
Reference in New Issue
Block a user