Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jun3453 committed Jul 14, 2021
1 parent e25345b commit e8a8b7b
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ jobs:
MAKE_PRETTY : false
MAKE_COMPACT : false
IS_PR_FROM_FORK: false
uses: jun3453/slack-pr-open-notification-action@v1.1.0
uses: jun3453/slack-pr-open-notification-action@v1.2.0
```
### Arguments
Expand All @@ -48,11 +48,6 @@ See the following URL: https://developer.github.com/v3/pulls/.
**boolean (DEFAULT: true)**
Whether to include the '@here' Slack mention when sending a message.
#### IS_PR_FROM_FORK
**boolean (DEFAULT: false)**
Whether notifications should support PRs from forks. By default, only the branch name is listed when sending a message.
If set to 'true', it will add the branch owner in front of the branch name ('owner:branch' vs 'branch'). If this option is used, you may need to enable fork pull request workflows under your repository's Actions settings.
#### MAKE_PRETTY
**boolean (DEFAULT: false)**
Pretty prints the information. Adds a "See Pull Request" button.
Expand All @@ -63,4 +58,11 @@ Pretty prints the information. Adds a "See Pull Request" button.
**boolean (DEFAULT: false)**
Smaller visual footprint.
![make_compact](https://github.com/raw/jun3453/slack-pr-open-notification-action/images/make_compact.png)
![make_compact](https://github.com/raw/jun3453/slack-pr-open-notification-action/images/make_compact.png)
#### IS_PR_FROM_FORK
**boolean (DEFAULT: false)**
Whether notifications should support PRs from forks. By default, only the branch name is listed when sending a message.
If set to 'true', it will add the branch owner in front of the branch name ('owner:branch' vs 'branch'). If this option is used, you may need to enable fork pull request workflows under your repository's Actions settings.
![make_compact and is_pr_fork](https://github.com/raw/jun3453/slack-pr-open-notification-action/images/make_compact_fork.png)

0 comments on commit e8a8b7b

Please sign in to comment.