GitHub Action
IRC Message Action
This action prints a message to a given IRC Channel. Optionally it waits for a response from a given user
The hostname of the IRC server
default: 'irc.libera.chat'
The port number of the IRC server
default: 6697
Required IRC channel that will receive the messages
IRC channel password
Required IRC nickname
IRC SASL password
Required Message to send
Use NOTICE instead of PRIVMSG
default: false
Use TLS to connect to the IRC server
default: true
Comma seperated list of authenticated accounts allowed to response to an action
Timeout to wait for a response in seconds
default: 60
Prevention strategy for excess flooding a channel Either "throttle" or "truncate".
-
truncate: cuts off the message after 3 lines. -
throttle: sends only 1 line per second.default: "throttle"
Enables verbose output.
default: false
nickname of the responding user
Response written from an authenticated user
on: [push]
jobs:
notification:
runs-on: ubuntu-latest
name: Notifications
steps:
- name: IRC notification
uses: Gottox/irc-message-action@v2
with:
channel: '##mychannel'
nickname: mynickname
message: |-
${{ github.actor }} pushed ${{ github.event.ref }} ${{ github.event.compare }}on: [push]
jobs:
deploy:
runs-on: ubuntu-latest
name: Deploy Chain
steps:
- name: Acknowledge
id: acknowledge
uses: Gottox/irc-message-action@v2
with:
channel: '##mychannel'
nickname: mynickname
response_allow_from: Operator1, Operator2, Operator3
# 5 hours:
response_timeout: 18000
message: |-
${{ github.actor }} pushed something: ${{ github.event.compare }}
Please acknowledge with "ok"!
# An Acknowledger can reply to this with "mynickname: ok"
- name: Print Acknowledger
run: echo "${{ steps.response.outputs.response_from }}"
- name: Check Acknowledge
run: test "${{ steps.response.outputs.response }}" = "ok"
- name: Deploy
run: ./deploy.sh