Compare commits

...

14 Commits

Author SHA1 Message Date
Jorge Alberto Díaz Orozco (Akiel) 3747b90846 Create dependabot.yml 2026-03-23 23:17:20 +01:00
Jorge Alberto Díaz Orozco (Akiel) b88d4128c7 Merge pull request #3 from jadolg/update-credentials-settings 2026-03-23 22:07:04 +00:00
Jorge Alberto Díaz Orozco (Akiel) 96b6b24841 Better handle errors on the new version 2026-03-23 23:06:05 +01:00
Jorge Alberto Díaz Orozco (Akiel) c551865cfd Use access tokens instead of userand password 2026-03-23 22:57:43 +01:00
Jorge Alberto Díaz Orozco (Akiel) d9187e3d33 Update version in readme 2026-03-23 21:35:08 +01:00
Jorge Alberto Díaz Orozco (Akiel) 765bd64e1d Remove references to the code input 2026-03-23 21:32:18 +01:00
Jorge Alberto Díaz Orozco (Akiel) 3a3db59139 Remove unused dockerfile 2026-03-23 21:30:56 +01:00
Jorge Alberto Díaz Orozco (Akiel) bde174722c Merge pull request #2 from jadolg/remove-docker-dependency 2026-03-23 20:30:07 +00:00
Jorge Alberto Díaz Orozco (Akiel) 1503fe229e Add logged in message 2026-03-23 21:28:09 +01:00
Jorge Alberto Díaz Orozco (Akiel) ddfa41a902 Logout at the end of the script 2026-03-23 21:26:00 +01:00
Jorge Alberto Díaz Orozco (Akiel) aac8c39c7d Migrate away from docker 2026-03-23 21:22:49 +01:00
Jorge Alberto Díaz Orozco (Akiel) 300c715940 Add github workflow to test the action 2026-03-23 21:19:39 +01:00
akiel a4fe40969a Add example taken from https://github.com/jadolg/rocketchat_API 2020-08-15 13:55:01 +02:00
akiel ab24dbba08 Update version in readme 2020-08-15 12:44:01 +02:00
6 changed files with 132 additions and 49 deletions
+6
View File
@@ -0,0 +1,6 @@
version: 2
updates:
- package-ecosystem: "github-actions"
directory: "/" # Location of package manifests
schedule:
interval: "monthly"
+20
View File
@@ -0,0 +1,20 @@
name: Test action
on:
pull_request:
branches: [master]
jobs:
test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- name: Send plain message
uses: ./
with:
server: ${{ secrets.ROCKETCHAT_SERVER }}
auth-token: ${{ secrets.ROCKETCHAT_AUTH_TOKEN }}
user-id: ${{ secrets.ROCKETCHAT_USER_ID }}
channel: "#test-notifications-akiel"
message: "Test plain message from ${{ github.repository }}@${{ github.sha }}"
-5
View File
@@ -1,5 +0,0 @@
FROM alpine:3.10
RUN apk --no-cache add ca-certificates
RUN wget https://github.com/aleph-engineering/rocketchat-notification/releases/download/1.4.1/rocketchat-notification -P /usr/bin/ && chmod +x /usr/bin/rocketchat-notification
COPY entrypoint.sh /entrypoint.sh
ENTRYPOINT ["/entrypoint.sh"]
+34 -12
View File
@@ -1,16 +1,17 @@
# Rocket.Chat notifications GitHub action
This action will write a message on your rocket.chat server using credentials instead of a webhook.
This action sends a message to a Rocket.Chat server using a personal access token.
Read <https://docs.rocket.chat/docs/manage-personal-access-tokens> to obtain a new access token.
## Inputs
### `user`
### `auth-token`
**Required** The username to login to your rocket.chat server.
**Required** Personal access token for your Rocket.Chat server.
### `password`
### `user-id`
**Required** The password to login to your rocket.chat server.
**Required** User ID associated with the personal access token.
### `message`
@@ -24,12 +25,10 @@ Your rocket.chat server. Default `"https://open.rocket.chat"`.
The channel you want to write to. Default `"GENERAL"`.
### `code`
Set it to true if you wish to have a code block. Default `"false"`.
## Example usage
### Push a chat notification when your job fails
```yaml
on: [push]
@@ -41,11 +40,34 @@ jobs:
- name: Push notification to rocket.chat if the job failed
id: error-notification
if: ${{ failure() }}
uses: jadolg/rocketchat-notification-action@v1.0.0
uses: jadolg/rocketchat-notification-action@v3.0.0
with:
server: ${{ secrets.ROCKETCHAT_SERVER }}
message: Wooops! Looks like something went wrong!
user: ${{ secrets.ROCKETCHAT_USER }}
password: ${{ secrets.ROCKETCHAT_PASSWORD }}
auth-token: ${{ secrets.ROCKETCHAT_AUTH_TOKEN }}
user-id: ${{ secrets.ROCKETCHAT_USER_ID }}
channel: alerts
```
### Push a chat notification when someone opens a pull request in your project
```yaml
name: PR_alert
on:
pull_request:
types: [opened, reopened]
branches: [ master ]
jobs:
alert:
runs-on: ubuntu-latest
steps:
- name: Push notification when a Pull Request is created
uses: jadolg/rocketchat-notification-action@v3.0.0
with:
message: Woop! Woop! A new Pull Request has being created at ${{ github.event.pull_request.html_url }}
auth-token: ${{ secrets.ROCKETCHAT_AUTH_TOKEN }}
user-id: ${{ secrets.ROCKETCHAT_USER_ID }}
channel: python_rocketchat_api
```
+24 -27
View File
@@ -1,38 +1,35 @@
name: 'Rocket.Chat notification with credentials'
description: 'Send a message to Rocket.Chat'
name: "Rocket.Chat notification"
description: "Send a message to Rocket.Chat"
branding:
icon: 'bell'
color: 'red'
icon: "bell"
color: "red"
inputs:
user:
description: 'The username to login to your rocket.chat server'
auth-token:
description: "Personal access token for your rocket.chat server"
required: true
default: ''
password:
description: 'The password to login to your rocket.chat server'
user-id:
description: "User ID associated with the personal access token"
required: true
message:
description: 'The message you want to send'
description: "The message you want to send"
required: true
server:
description: 'Your rocket.chat server'
description: "Your rocket.chat server"
required: false
default: 'https://open.rocket.chat'
default: "https://open.rocket.chat"
channel:
description: 'The channel you want to write to'
description: "The channel you want to write to"
required: false
default: 'GENERAL'
code:
description: 'Set it to true if you wish to have a code block'
required: false
default: 'false'
default: "GENERAL"
runs:
using: 'docker'
image: 'Dockerfile'
args:
- ${{ inputs.user }}
- ${{ inputs.password }}
- ${{ inputs.message }}
- ${{ inputs.server }}
- ${{ inputs.channel }}
- ${{ inputs.code }}
using: "composite"
steps:
- name: Send Rocket.Chat notification
shell: bash
run: ${{ github.action_path }}/entrypoint.sh
env:
INPUT_AUTH_TOKEN: ${{ inputs.auth-token }}
INPUT_USER_ID: ${{ inputs.user-id }}
INPUT_MESSAGE: ${{ inputs.message }}
INPUT_SERVER: ${{ inputs.server }}
INPUT_CHANNEL: ${{ inputs.channel }}
+48 -5
View File
@@ -1,6 +1,49 @@
#!/usr/bin/env sh
if $6 == "true"; then
rocketchat-notification -u "$1" -p "$2" -m "$3" -s "$4" -c "$5" -code
else
rocketchat-notification -u "$1" -p "$2" -m "$3" -s "$4" -c "$5"
#!/usr/bin/env bash
set -euo pipefail
GREEN='\033[0;32m'
RED='\033[0;31m'
BOLD='\033[1m'
RESET='\033[0m'
SERVER="${INPUT_SERVER}"
AUTH_TOKEN="${INPUT_AUTH_TOKEN}"
USER_ID="${INPUT_USER_ID}"
MESSAGE="${INPUT_MESSAGE}"
CHANNEL="${INPUT_CHANNEL}"
HTTP_CODE=$(curl -s -o /tmp/rc_response -w "%{http_code}" -X POST \
-H "Content-Type: application/json" \
-H "X-Auth-Token: ${AUTH_TOKEN}" \
-H "X-User-Id: ${USER_ID}" \
-d "$(jq -n --arg channel "$CHANNEL" --arg text "$MESSAGE" '{"channel": $channel, "text": $text}')" \
"${SERVER}/api/v1/chat.postMessage") || {
echo -e "${RED}${BOLD}✗ Connection failed${RESET} — could not reach ${SERVER}"
exit 1
}
RESPONSE=$(cat /tmp/rc_response)
if [ "$HTTP_CODE" = "401" ]; then
echo -e "${RED}${BOLD}✗ Authentication failed${RESET} — invalid auth-token or user-id"
exit 1
fi
if ! jq -e '.success' <<< "$RESPONSE" > /dev/null 2>&1; then
echo -e "${RED}${BOLD}✗ Unexpected response${RESET} (HTTP ${HTTP_CODE})"
exit 1
fi
SUCCESS=$(jq -r '.success' <<< "$RESPONSE")
if [ "$SUCCESS" != "true" ]; then
ERROR=$(jq -r '.error // .message // "unknown error"' <<< "$RESPONSE")
echo -e "${RED}${BOLD}✗ Failed to send message${RESET}${ERROR}"
exit 1
fi
mapfile -t response_data < <(jq -r '.channel, .message.u.username, .message._id' <<< "$RESPONSE")
CHANNEL_NAME="${response_data[0]}"
SENDER="${response_data[1]}"
MSG_ID="${response_data[2]}"
echo -e "${GREEN}${BOLD}✓ Message sent${RESET} — channel: ${BOLD}${CHANNEL_NAME}${RESET}, sender: ${SENDER}, id: ${MSG_ID}"