https://github.com/techulus/push-github-action

Github Action for Push by Techulus
https://github.com/techulus/push-github-action

Last synced: 9 days ago
JSON representation

Github Action for Push by Techulus

• Host: GitHub
• URL: https://github.com/techulus/push-github-action
• Owner: techulus
• License: mit
• Created: 2019-02-19T08:56:57.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-01-06T02:56:45.000Z (10 months ago)
• Last Synced: 2024-10-08T18:31:59.971Z (about 1 month ago)
• Language: JavaScript
• Size: 3.47 MB
• Stars: 72
• Watchers: 5
• Forks: 18
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-actions - Send a Push Notification via Push by Techulus
• fucking-awesome-actions - Send a Push Notification via Push by Techulus
• awesome-workflows - Send a Push Notification via Push by Techulus

README

        


# Github Action for Push Notification

Receive push notification to your devices using Github Actions

## Pre-requisites

To run this action you'll need:

- An API key from Push (https://push.techulus.com/)

## Setup

1. Create the workflow and choose any event of your choice.

2. Copy and paste the following snippet into your .yml file.

```

- name: Send Push Notification

  uses: techulus/[email protected]

```

3. Add a new secret `API_KEY` (your API key) and an environment variable `MESSAGE` (notification message)

4. Commit your changes!

## Sample Workflows

### Send notification on every commit

```yaml

name: Push on commit

on: [push]

jobs:

  build:

    runs-on: ubuntu-latest

    steps:

    - name: Send Push Notification

      uses: techulus/[email protected]

      env:

        API_KEY: ${{ secrets.API_KEY }}

        MESSAGE: "There is a new commit!"

```

### Send notification using schedule trigger

```yaml

name: Test push every day

on: 

  schedule:

    - cron: '* 0 * * *'

jobs:

  build:

    runs-on: ubuntu-latest

    steps:

    - name: Send Push Notification

      uses: techulus/[email protected]

      env:

        API_KEY: ${{ secrets.API_KEY }}

        MESSAGE: "Test notification from GitHub"

```

### Customize notification title / add a link

```yaml

name: Test push every day

on: 

  schedule:

    - cron: '* 0 * * *'

jobs:

  build:

    runs-on: ubuntu-latest

    steps:

    - name: Send Push Notification

      uses: techulus/[email protected]

      env:

        API_KEY: ${{ secrets.API_KEY }}

        MESSAGE: "Test notification from GitHub 🧪"

        TITLE: Testing

        LINK: https://github.com/techulus/push-github-action

        SOUND: scifi

        TIME_SENSITIVE: true

```

## Support

Feature Request, Bugs and Ideas can be added [here.](https://pushbytechulus.freshdesk.com/support/tickets/new)