GitHub Action
Apprise Notification
GitHub Action to send a dynamic push notification to every single platform thanks to the Apprise library
Supports services like Slack, AWS SNS, Discord, IFTTT, Matrix, Microsoft Teams, Telegram, Twitter etc., as well as email and webhooks.
Supports dynamically adding event data to the notification message with Jinja2 templates.
uses: cstuder/apprise-ga@master
with:
title: "Notification title"
message: "Message"
env:
APPRISE_URL: ${{ secrets.APPRISE_URL }}
- Create a new action in your workflow which uses
cstuder/apprise-ga@master
. (Or a tagged version.) - Look up the syntax for your push notification URL in the list of Supported Notifications by Apprise. (I.e.
protocol://user:password@hostname/channel
) - Create a repository secret named
APPRISE_URL
with your URL as content. - Add your message as inputs
title
ormessage
.
For both title and message you can use the Jinja2 syntax to insert data from the event trigger (/github/workflow/event.json
) into your notification.
Find the event data in the list of GitHub webhook payloads.
For a push event, you might use the following arguments:
title: "Push received on {{ ref }}"
message: "Commit by {{ head_commit.author.name }}: {{ head_commit.message | truncate(128) }} ({{ head_commit.id[0:7] }})"
Required String with notification title.
Required String with notification message.
Required Notification URL(s) according to the Apprise documentation.
To notify mulitple URLs, add them separated by spaces.
MIT.