Skip to content

Commit

Permalink
docs: updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Netail committed Mar 29, 2024
1 parent fd2eff1 commit 07edbe1
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ jobs:
with:
discord-url: 'https://discord.com/api/webhooks/...'
slack-url: 'https://hooks.slack.com/services/...'
teams-url: 'https://outlook.office.com/webhook/...'
teams-url: '["https://outlook.office.com/webhook/...", "https://outlook.office.com/webhook/..."]'
color: 'info'
title: '${{ github.event.pull_request.user.login }} opened PR-${{ github.event.number }} in ${{ github.event.repository.name }}'
text: ${{ github.event.pull_request.title }}
Expand All @@ -46,10 +46,10 @@ The action has any of the follow inputs
| Name | Description | Default | Notes |
| - | - | - | - |
| `dry-run` | Prevent sending the payload | false | |
| `discord-url` | Discord Webhook URL | N/A | Discord does not support buttons in incoming webhooks, yet... |
| `slack-url` | Slack Webhook URL | N/A | |
| `teams-url` | Teams Webhook URL | N/A | Teams has deprecated giving colors to a card... |
| `color` | Color of the message in hexadecimal or title of predefined | `success` | |
| `discord-url` | Discord Webhook URL(s) | N/A | Optional: Can be stringified JSON array of strings. Discord does not support buttons in incoming webhooks, yet |
| `slack-url` | Slack Webhook URL(s) | N/A | Optional: Can be stringified JSON array of strings. |
| `teams-url` | Teams Webhook URL(s) | N/A | Optional: Can be stringified JSON array of strings. Teams has deprecated colors in cards (temporarily) |
| `color` | Color of the message | `success` | Value can be in hexadecimal or the title of a predefined color |
| `title` | Text at the top of the message | `Hello world!` | |
| `text` | Text to be displayed under the title | N/A | |
| `fields` | Extra info to be displayed under the message | N/A | Stringified JSON array of objects with the attributes `name` and `value` ( e.g. `'[{"name": "string", "value": "string"}]'`) |
Expand Down

0 comments on commit 07edbe1

Please sign in to comment.