https://github.com/ShaunLWM/action-join

🔔 A Github action to push Join notifications to your devices.
https://github.com/ShaunLWM/action-join

android-join github-actions join

Last synced: 2 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/ShaunLWM/action-join
• Owner: ShaunLWM
• License: mit
• Created: 2019-09-05T14:28:12.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2020-03-29T05:13:25.000Z (almost 5 years ago)
• Last Synced: 2024-10-09T21:48:39.645Z (3 months ago)
• Topics: android-join, github-actions, join
• Language: Dockerfile
• Homepage:
• Size: 14.6 KB
• Stars: 5
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-actions - Send a Push Notification via Join
• fucking-awesome-actions - Send a Push Notification via Join
• awesome-workflows - Send a Push Notification via Join

README

        
# Join Notifications for GitHub Actions

![screenshot](screenshot.png)

This action allows you to send yourself a push notification via [Join](https://play.google.com/store/apps/details?id=com.joaomgcd.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](https://joinjoaomgcd.appspot.com/) 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](https://joaoapps.com/join/api/) about the required parameters and the keys above.

## Credits

Based off [maddox/actions](https://github.com/maddox/actions/tree/master/pushover)

## License

MIT 2019