Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bharathvaj1995/clockwork-sms-action

Send SMS notification from GitHub Actions using Clockworksms.
https://github.com/bharathvaj1995/clockwork-sms-action

clockwork clockwork-sms github-actions github-actions-javascript javascript sms textanywhere

Last synced: about 2 months ago
JSON representation

Send SMS notification from GitHub Actions using Clockworksms.

Awesome Lists containing this project

README

        

# Clockwork SMS Action

Send an SMS from [GitHub Actions](https://github.com/features/actions) using [Clockworksms](https://www.clockworksms.com/).

## Usage

```workflow
name: Push Notification Trigger
on:
push:
branches:
- master
jobs:
send-sms:
name: Send SMS
runs-on: ubuntu-latest
steps:
- name: Send SMS
uses: bharathvaj1995/clockwork-sms-action@master
env:
CLOCKWORK_API_KEY: ${{ secrets.CLOCKWORK_API_KEY }}
with:
to: 447000000000
content: "New push on ${{ github.repository }} from ${{ github.actor }}"
```

will send SMS `New push on org-name/repo-name from your_username` to `447000000000`.

## Secrets

This action uses the `CLOCKWORK_API_KEY` from secrets:

### Getting an api key

First, head over to clockwork and signup if you're not already signed up. Once signed up, log in to your clockwork account and add a new API Key (from the top menu choose Sending -> API Keys).

## Event Information

All of the information attached to an event is available in the `github.event` variable. To see the possible values, you can use the following step in your workflow:

```yaml
- run: echo '${{ toJson(github.event) }}'
```

You can use this information in both the inputs for your action and to run the action conditionally.

Here's an example of sending an SMS any time an issue is created with the urgent label:

```workflow
name: Issue Notification
on:
issues:
types: [labeled]
jobs:
send-sms:
name: Send SMS
runs-on: ubuntu-latest
steps:
- name: Send SMS
uses: bharathvaj1995/clockwork-sms-action@master
env:
CLOCKWORK_API_KEY: ${{ secrets.CLOCKWORK_API_KEY }}
with:
to: ${{ secrets.SECRET_NUMBER }}
content: "This urgent issue needs your attention: ${{ github.event.issue.html_url }}"
if: github.event.label.name == 'urgent'
```

## Show your support

Give a ⭐️ if this project helped you!

## 📝 License

Copyright © 2020 [Bharathvaj Ganesan](https://github.com/bharathvaj1995).

This project is [MIT](https://github.com/bharathvaj1995/clockwork-sms-action/blob/master/LICENSE) licensed.