nhomble/groupme-notify-action

:toc: macro = groupme-notify-action

image:https://github.com/nhomble/groupme-notify-action/workflows/Linter/badge.svg[Linter]

[.lead] a github action to send groupme messages

toc::[]

== Examples This action supports two styles of messaging.

You can create a link:https://dev.groupme.com/bots[bot] associated with that group and just invoke the bot apis with your token and botId.
Directly with the GroupMe groupId and your access token, you can message a group with your identity.

We recommend you go with option (1) since you'll typically receive notifications on your GroupMe client from a bot but not from yourself.

=== Message with a bot image:https://user-images.githubusercontent.com/3923558/104136448-23f49a80-5364-11eb-9fd7-6ecd269c4577.png[Message with bot] [source,yml]

name: groupme-notify on: [push]

jobs: groupme: runs-on: ubuntu-latest name: notify steps: - name: Checkout uses: actions/checkout@v2 - name: do notification as bot uses: nhomble/groupme-notify-action@v1 id: bot with: bot: ${{ secrets.YOUR_BOT_ID }} message: "It's a bot!" token: ${{ secrets.YOUR_API_KEY }}

=== Message as yourself image:https://user-images.githubusercontent.com/3923558/104116315-7b075a80-52e5-11eb-9fde-212fcd937675.png[Message yourself] [source,yml]

name: groupme-notify on: [push]

jobs: groupme: runs-on: ubuntu-latest name: notify steps: - name: Checkout uses: actions/checkout@v2 - name: do notification uses: nhomble/groupme-notify-action@v1 id: notification with: group: ${{ secrets.YOUR_GROUP_ID }} message: 'Test notification!' token: ${{ secrets.YOUR_API_KEY }}

Note: you can define both the group and bot parameter in your yml. This action will give precedence to the bot mode so that group parameter will be ignored.

== GroupMe Specifics You will want to visit https://dev.groupme.com/docs/v3[GroupMe API] for exhaustive documentation.

=== How do I create a bot? Through the link:https://dev.groupme.com/bots[GroupMe Dev] portal, you can click the Create Bot button. From the UI, the Bot ID parameter is what you need to pass to this action.

=== What is the groupId? You'll need to perform a GET against the GroupMe APIs to find the groupId for the group you want. After you login, you can retrieve your access token from the UI.

Given your access token, you can get a list of all the groups you are a part of by doing: [source,bash]

$ TOKEN= $ curl
-H "Content-Type: application/json"
https://api.groupme.com/v3/groups?token=$TOKEN

What you care about is: [source,json]

{ "response": [ {"id": "", "name": "GitHub", "...": "..."}, {"id": "123456", "name": "Family", "...": "..."}, {"id": "789023", "name": "Friends", "...": "..."} ] }

Based off of the name, figure out the groupId you want to use and then put that into your action.yml.

groupme-notify-action

Commits

pin to v0.2

Update Dockerfile

clearer group docs

clearer group docs

clearer names

Merge pull request #2 from nhomble/allow-bot

README

=== Message with a bot image:https://user-images.githubusercontent.com/3923558/104136448-23f49a80-5364-11eb-9fd7-6ecd269c4577.png[Message with bot] [source,yml]

jobs: groupme: runs-on: ubuntu-latest name: notify steps: - name: Checkout uses: actions/checkout@v2 - name: do notification as bot uses: nhomble/groupme-notify-action@v1 id: bot with: bot: ${{ secrets.YOUR_BOT_ID }} message: "It's a bot!" token: ${{ secrets.YOUR_API_KEY }}

=== Message as yourself image:https://user-images.githubusercontent.com/3923558/104116315-7b075a80-52e5-11eb-9fde-212fcd937675.png[Message yourself] [source,yml]

jobs: groupme: runs-on: ubuntu-latest name: notify steps: - name: Checkout uses: actions/checkout@v2 - name: do notification uses: nhomble/groupme-notify-action@v1 id: notification with: group: ${{ secrets.YOUR_GROUP_ID }} message: 'Test notification!' token: ${{ secrets.YOUR_API_KEY }}

Given your access token, you can get a list of all the groups you are a part of by doing: [source,bash]

$ TOKEN= $ curl
-H "Content-Type: application/json"
https://api.groupme.com/v3/groups?token=$TOKEN

What you care about is: [source,json]

{ "response": [ {"id": "", "name": "GitHub", "...": "..."}, {"id": "123456", "name": "Family", "...": "..."}, {"id": "789023", "name": "Friends", "...": "..."} ] }

groupme-notify-action

Commits

pin to v0.2

Update Dockerfile

clearer group docs

clearer group docs

clearer names

Merge pull request #2 from nhomble/allow-bot

README

=== Message with a bot image:https://user-images.githubusercontent.com/3923558/104136448-23f49a80-5364-11eb-9fd7-6ecd269c4577.png[Message with bot] [source,yml]

jobs: groupme: runs-on: ubuntu-latest name: notify steps: - name: Checkout uses: actions/checkout@v2 - name: do notification as bot uses: nhomble/groupme-notify-action@v1 id: bot with: bot: ${{ secrets.YOUR_BOT_ID }} message: "It's a bot!" token: ${{ secrets.YOUR_API_KEY }}

=== Message as yourself image:https://user-images.githubusercontent.com/3923558/104116315-7b075a80-52e5-11eb-9fde-212fcd937675.png[Message yourself] [source,yml]

jobs: groupme: runs-on: ubuntu-latest name: notify steps: - name: Checkout uses: actions/checkout@v2 - name: do notification uses: nhomble/groupme-notify-action@v1 id: notification with: group: ${{ secrets.YOUR_GROUP_ID }} message: 'Test notification!' token: ${{ secrets.YOUR_API_KEY }}

Given your access token, you can get a list of all the groups you are a part of by doing: [source,bash]

$ TOKEN= $ curl -H "Content-Type: application/json" https://api.groupme.com/v3/groups?token=$TOKEN

What you care about is: [source,json]

{ "response": [ {"id": "", "name": "GitHub", "...": "..."}, {"id": "123456", "name": "Family", "...": "..."}, {"id": "789023", "name": "Friends", "...": "..."} ] }

$ TOKEN= $ curl
-H "Content-Type: application/json"
https://api.groupme.com/v3/groups?token=$TOKEN