yasser5711/Discord PR Notifications
Send customizable Discord notifications for PR events (opened, merged, reviewed, etc.)
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| dry_run | If true, generates payload but doesn't send to Discord (for testing) | no | false |
| discord_webhook_url | Discord webhook URL | yes | — |
| discord_id_map_json | JSON mapping GitHub usernames → Discord IDs (for mentions) | yes | — |
| giphy_api_key | Optional GIPHY API key used for GIF search | no | — |
| enable_gif | Enable GIFs (requires giphy_api_key and tags) | no | false |
| include_author | Include PR author field in embed | no | true |
| include_actor | Include actor (reviewer/merger/etc.) field in embed | no | true |
| include_description | Include PR description/body field in embed | no | true |
| enable_mentions | Allow Discord mentions for mapped users | no | true |
| embed_username | Override webhook username (default: -) | no | — |
| embed_avatar_url | Override webhook avatar URL | no | — |
| footer_text | Override footer text (default: 'Repo: <repo>') | no | — |
| footer_icon_url | Override footer icon URL | no | — |
| send_on_approved | Send notification on review: approved | no | true |
| send_on_changes_requested | Send notification on review: changes_requested | no | true |
| send_on_commented | Send notification on review: commented | no | true |
| send_on_merged | Send notification on PR merged | no | true |
| send_on_closed | Send notification on PR closed (not merged) | no | true |
| send_on_opened | Send notification on PR opened | no | true |
| send_on_reopened | Send notification on PR reopened | no | true |
| send_on_ready_for_review | Send notification when PR is ready_for_review | no | true |
| send_on_draft | Send notification when PR is converted to draft | no | true |
| msg_approved | Template for 'approved' message (use {author}, {actor}, {number}, {title}, {repo}, {url}, {status}, {action}) | no | — |
| msg_changes_requested | Template for 'changes_requested' message | no | — |
| msg_commented | Template for 'commented' message | no | — |
| msg_merged | Template for 'merged' message | no | — |
| msg_closed | Template for 'closed' message | no | — |
| msg_opened | Template for 'opened' message | no | — |
| msg_reopened | Template for 'reopened' message | no | — |
| msg_ready_for_review | Template for 'ready_for_review' message | no | — |
| msg_draft | Template for 'draft' message | no | — |
| tags_approved | Multi-line YAML list of GIF tags for 'approved' | no | — |
| tags_changes_requested | Multi-line YAML list of GIF tags for 'changes_requested' | no | — |
| tags_commented | Multi-line YAML list of GIF tags for 'commented' | no | — |
| tags_merged | Multi-line YAML list of GIF tags for 'merged' | no | — |
| tags_closed | Multi-line YAML list of GIF tags for 'closed' | no | — |
| tags_opened | Multi-line YAML list of GIF tags for 'opened' | no | — |
| tags_reopened | Multi-line YAML list of GIF tags for 'reopened' | no | — |
| tags_ready_for_review | Multi-line YAML list of GIF tags for 'ready_for_review' | no | — |
| tags_draft | Multi-line YAML list of GIF tags for 'draft' | no | — |
| title_approved | Title for 'approved' | no | — |
| title_changes_requested | Title for 'changes_requested' | no | — |
| title_commented | Title for 'commented' | no | — |
| title_merged | Title for 'merged' | no | — |
| title_closed | Title for 'closed' | no | — |
| title_opened | Title for 'opened' | no | — |
| title_reopened | Title for 'reopened' | no | — |
| title_ready_for_review | Title for 'ready_for_review' | no | — |
| title_draft | Title for 'draft' | no | — |
| color_approved | Color for 'approved' (integer, e.g. 3066993) | no | — |
| color_changes_requested | Color for 'changes_requested' | no | — |
| color_commented | Color for 'commented' | no | — |
| color_merged | Color for 'merged' | no | — |
| color_closed | Color for 'closed' | no | — |
| color_opened | Color for 'opened' | no | — |
| color_reopened | Color for 'reopened' | no | — |
| color_ready_for_review | Color for 'ready_for_review' | no | — |
| color_draft | Color for 'draft' | no | — |
| timestamp | Timestamp for the event (ISO 8601 format) | no | — |
Outputs
no outputs