Skip to content

🔔 A Github action to push Join notifications to your devices.

License

Notifications You must be signed in to change notification settings

ShaunLWM/action-join

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Join Notifications for GitHub Actions

screenshot

This action allows you to send yourself a push notification via Join.

Usage

To use the action simply add the following lines to your .github/main.workflow and provide the required Secrets and Environment variables.

action "Build Completion" {
  uses = "ShaunLWM/action-join@master"
  secrets = ["JOIN_DEVICE_ID", "JOIN_API_KEY"]
  env = {
    JOIN_TITLE = "Build Complete"
    JOIN_TEXT = "Your project has been built."
  }
}

YML

name: Join Notification to Device X
on: [push]
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@master
    - name: Join Notification
      uses: ShaunLWM/action-join@master
      env:
        JOIN_API_KEY: ${{ secrets.JOIN_API_KEY }}
        JOIN_DEVICE_ID: ${{ secrets.JOIN_DEVICE_ID }}
        JOIN_TEXT: Your project has been built.
        JOIN_TITLE: Build Complete

Secrets

You'll need to provide these secrets to use the action. Enter these secrets in your Settings > Secrets

  • JOIN_DEVICE_ID: Select your device from Join and copy the Device Id under Join API
  • JOIN_API_KEY: Similarly, in Join API, click Show at API Key section.

Environment Variables

You'll need to provide these environment variables to specify exactly what information to send to your device.

  • JOIN_TITLE: The title of the notification.
  • JOIN_TEXT: The body of the notification.

Learn more about the required parameters and the keys above.

Credits

Based off maddox/actions

License

MIT 2019

About

🔔 A Github action to push Join notifications to your devices.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published