https://github.com/eikendev/gotify-action

A GitHub Action to send notifications via Gotify
https://github.com/eikendev/gotify-action

actions github-action gotify

Last synced: 4 days ago
JSON representation

A GitHub Action to send notifications via Gotify

• Host: GitHub
• URL: https://github.com/eikendev/gotify-action
• Owner: eikendev
• License: isc
• Created: 2020-03-31T17:23:38.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-11-28T17:30:35.000Z (almost 4 years ago)
• Last Synced: 2024-10-20T10:13:16.392Z (24 days ago)
• Topics: actions, github-action, gotify
• Language: Shell
• Homepage: https://github.com/marketplace/actions/gotify-notification
• Size: 3.91 KB
• Stars: 8
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Gotify Notification Action

This action allows you to send push notifications via [Gotify](https://gotify.net/).

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.

```yaml

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.