8000 GitHub - polvoazul/apprise-ga: GitHub Action to send a dynamic push notification to every single platform thanks to the Apprise library
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

polvoazul/apprise-ga

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

27 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

apprise-ga

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.

Example usage

uses: cstuder/apprise-ga@master
with:
  title: "Notication title"
  message: "Message"
env:
  APPRISE_URL: ${{ secrets.APPRISE_URL }}

Complete usage

  1. Create a new action in your workflow which uses cstuder/apprise-ga@master. (Or a tagged version.)
  2. Look up the syntax for your push notification URL in the list of Supported Notifications by Apprise. (I.e. protocol://user:password@hostname/channel)
  3. Create a repository secret named APPRISE_URL with your URL as content.
  4. Add your message as inputs title or message.

Inserting event data with templates

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.

Templating example

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] }})"

Inputs

title

Required String with notification title.

message

Required String with notification message.

Secrets

APPRISE_URL

Required Notification URL according to the Apprise documentation

License

MIT.

About

GitHub Action to send a dynamic push notification to every single platform thanks to the Apprise library

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Shell 83.0%
  • Dockerfile 17.0%
0