A GitHub Action to send notifications via Gotify
Find a file
2020-11-28 18:29:54 +01:00
.github/workflows Rename repository 2020-11-28 18:29:54 +01:00
action.yml Rework action inputs 2020-03-31 20:09:22 +02:00
Dockerfile Remove chmod from Dockerfile 2020-03-31 19:52:04 +02:00
entrypoint.sh Rework action inputs 2020-03-31 20:09:22 +02:00
LICENSE Initialize repository 2020-03-31 19:22:19 +02:00
README.md Rename repository 2020-11-28 18:29:54 +01:00

Gotify Notification Action

This action allows you to send push notifications via Gotify. Gotify is an open-source push notification server.

Inputs

notification_title

Required The title of the Gotify notification.

notification_message

Required The message of the Gotify notification. Default "".

notification_priority

Required The priority of the Gotify notification. Default 4.

Outputs

This action has no outputs.

Secrets

gotify_api_base

Required The HTTP endpoint where the Gotify API is exposed.

gotify_app_token

Required The token of the Gotify application.

Usage

Create a file .github/workflows/main.yml in your repository with the following contents.

name: 'Gotify Notification'
on: [push]
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@master
    - name: Gotify Notification
      uses: eikendev/gotify-action@master
      with:
        gotify_api_base: '${{ secrets.gotify_api_base }}'
        gotify_app_token: '${{ secrets.gotify_app_token }}'
        notification_title: 'Build Complete'
        notification_message: 'Your build was completed.'

Do not forget to define the secrets so the action can complete successfully.