https://github.com/bulkgate/github-actions
https://github.com/bulkgate/github-actions
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/bulkgate/github-actions
- Owner: BulkGate
- Created: 2021-11-23T08:35:30.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2021-12-10T12:13:37.000Z (over 3 years ago)
- Last Synced: 2025-01-03T04:17:46.476Z (5 months ago)
- Language: JavaScript
- Size: 5.9 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# BulkGate Github SMS actions
Send SMS via Github actions
## Setup
- Go to your repository settings. Click secrets and set your application_id and application_token as secrets.
- Set inputs in your workflow based on one of these uses cases.
## SMS notification workflow
Workflow allowing to connect github event as push, pull request and many others to BulkGate API
```
jobs:
notification:
runs-on: ubuntu-latest
name: Send SMS after push
environment: bulkgate_api
steps:
- name: Send SMS after push
uses: BulkGate/github-actions@master
id: SendSMS
with:
application_id: ${{ secrets.application_id }}
application_token: ${{ secrets.application_token }}
number: "420777777777"
text: "test"
sender_id: "gText"
sender_id_value: "Github test"
- name: Get http response
run: echo "Response is ${{ steps.SendSMS.outputs.response }}"
```
## Inputs
| PARAMETER NAME | VALUE | MANDATORY | DEFAULT VALUE |
|:--- |:--- |:--- |:--- |
|application_id| [Application ID](https://help.bulkgate.com/docs/en/api-administration.html#what-is-application-id) |**Yes**|-|
|application_token| [Application token](https://help.bulkgate.com/docs/en/api-tokens.html#what-is-an-api-token) |**Yes**|-|
|number| Recipient number |**Yes** or `admin`|-|
|admin| Number of BulkGate administrator receiving notification. [More info](https://help.bulkgate.com/docs/en/http-advanced-transactional-admin.html) |**Yes** or `number`|-|
|text| Text of the SMS message (max. 612 characters, or 268 characters, if Unicode is activated), UTF-8 encoding. It is possible to add variables to the template from the `variables` array (another parameter) `Hello ....` |**Yes**|-|
|variables| Associative array to add variables to text, for e.g.: `{"first_name": "John", "last_name": "Doe"}`| No | `[]` |
|unicode |`Yes`/`true`/`1` for Unicode SMS, `no`/`false`/`0` for 7bit SMS|No|`false`|
|sender_id| Sender ID, see [Sender ID type](#sender-id-type-sender_id) | No |`gSystem`|
|sender_id_value| Sender value `gOwn`, `gText`, `gMobile`, `gProfile` or `gPush` (if `gMobile`, or `gPush` used, please supply `mobile connect key` as `sender_id_value`)| No |`null`|
|country| Provide recipient numbers in international format (with prefix, for e.g `44`), or add [country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) (`7820125799` + `GB` = `447820125799`). See the example of a country requirement. If the value is **`null,`** your set time zone will be used to fill in the information | No |`null`|
|schedule| Schedule the sending time and date in [unix timestamp,](https://en.wikipedia.org/wiki/Unix_time) or [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601). | No |Now|
|channel| Alternative channels. If message cannot be send by one channel, channel next in line will be used.
|duplicates_check| Select **`on`** to prevent sending duplicate messages to the same phone number. Messages with the same text sent to the same number will be removed if there is a time interval shorter than 5 mins. If **`off`** no duplicates will be removed. |No|`off`|
|tag|Message label for subsequent retrieval of the user.|No|-|
### Sender ID type `sender_id`
| VALUE| MEANING|
|:--- |:---|
|`gSystem` |System number|
|`gShort`|Short Code|
|`gText` |Text sender|
|`gMobile`|Mobile Connect - Sends SMS message through Mobile Connect app|
|`gPush`|Mobile Connect push - Sends a notification to the Mobile Connect app|
|`gOwn` |Own number (requires number verification)|
|`gProfile`|[BulkGate Profile ID](https://help.bulkgate.com/docs/en/sender-id-profile.html)|
| `` |BulkGate Profile ID|
## After testing notification workflow
Workflow consisting of two jobs latter being dependand on the first one. When first job fails as a result of faulty nette test, notification SMS will be send out to specified phone number. Second job wont trigger if first is successful.
```
jobs:
package_tested:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- name: Install dependencies
run: composer install --prefer-dist --no-progress
- name: Run test suite
id: run_tests
run: composer run tester
notification:
runs-on: ubuntu-latest
name: Send SMS after push
environment: bulkgate_api
needs: [package_tested]
if: always() && (needs.package_tested.result == 'failure')
steps:
- name: Send SMS after push
uses: BulkGate/github-actions@master
id: SendSMS
with:
application_id: ${{ secrets.application_id }}
application_token: ${{ secrets.application_token }}
number: "420777777777"
text: ${{ github.server_url }}/${{ github.repository }}/actions
sender_id: "gText"
sender_id_value: "Github test"
channel: '{
"viber": {
"sender": "BulkGate",
"expiration": 100,
"text": "test"
},
"sms": {
"sender_id": "gText",
"sender_id_value": "Lt-Hagan",
"unicode": true,
"flash": true,
"text": "test"
}
}'
- name: Get http response
run: echo "Response is ${{ steps.SendSMS.outputs.response }}"
```
## Alternative after testing notification workflow
Alternative workflow consisting of two separate workflow files. After first one is resolved second will send SMS based on the first ones success, or failure.
Second workflow will trigger regardless on result of the first workflow, but could send different SMS notification.
### main.yml
```
name: Main_Workflow
on: [push]
jobs:
package_tested:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- name: Install dependencies
run: composer install --prefer-dist --no-progress
- name: Run test suite
id: run_tests
run: composer run tester
```
### report.yml
```
name: Report
on:
workflow_run:
workflows: ["Main_Workflow"]
branches: [master]
types:
- completed
jobs:
on-success:
runs-on: ubuntu-latest
name: Report tests
environment: bulkgate_api
if: ${{ github.event.workflow_run.conclusion == 'success' }}
steps:
- name: "Report success"
uses: BulkGate/github-actions@master
with:
application_id: ${{ secrets.application_id }}
application_token: ${{ secrets.application_token }}
number: "420777777777"
text: "test"
sender_id: "gText"
sender_id_value: "BulkGate tester"
channel: '{
"viber": {
"sender": "BulkGate",
"expiration": 100,
"text": "test"
},
"sms": {
"sender_id": "gText",
"sender_id_value": "Lt-Hagan",
"unicode": true,
"flash": true,
"text": "test"
}
}'
- name: Get http response
run: echo "Response is ${{ steps.SendSMS.outputs.response }}"
on-failure:
runs-on: ubuntu-latest
if: ${{ github.event.workflow_run.conclusion == 'failure' }}
steps:
- name: "Report failure"
uses: BulkGate/github-actions@master
with:
application_id: ${{ secrets.application_id }}
application_token: ${{ secrets.application_token }}
number: "420777777777"
text: "test"
sender_id: "gText"
sender_id_value: "BulkGate tester"
channel: '{
"viber": {
"sender": "BulkGate",
"expiration": 100,
"text": "test"
},
"sms": {
"sender_id": "gText",
"sender_id_value": "Lt-Hagan",
"unicode": true,
"flash": true,
"text": "test"
}
}'
- name: Get http response
run: echo "Response is ${{ steps.SendSMS.outputs.response }}"
```