https://github.com/allejo/supybot-notification-action
An Action for GitHub Actions to push messages to a Supybot instance on IRC
https://github.com/allejo/supybot-notification-action
github-actions supybot
Last synced: 3 months ago
JSON representation
An Action for GitHub Actions to push messages to a Supybot instance on IRC
- Host: GitHub
- URL: https://github.com/allejo/supybot-notification-action
- Owner: allejo
- License: mit
- Created: 2020-08-02T01:52:05.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2023-01-05T13:04:17.000Z (over 2 years ago)
- Last Synced: 2025-03-18T00:37:50.476Z (3 months ago)
- Topics: github-actions, supybot
- Language: TypeScript
- Homepage: https://github.com/marketplace/actions/supybot-irc-messages-action
- Size: 1.13 MB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Supybot Notification Action
[](https://github.com/allejo/supybot-notification-action/actions)
A GitHub Actions action that lets you send notifications to a [Limnoria (fka Supybot)](https://github.com/ProgVal/Limnoria) instance using the [supybot-github plugin](https://github.com/kongr45gpen/supybot-github).
## Usage
```yaml
- name: Send IRC notification
uses: allejo/supybot-notification-action@v1
if: always()
with:
status: ${{ job.status }}
hostname: 'supybothost.com:8090'
credentials: ${{ secrets.SUPYBOT_PASSWORD }}
channel: '#my-channel'
default_message: true
```
### Parameters
- `status` - The status of the job: `success`, `failure` or `canceled`. Use the `${{ job.status }}` value available in GitHub actions to get this value automatically.
- `hostname` - The host of where the Supybot instance with the "supybot-github" plugin is being hosted.
- `credentials` - The credentials for Basic Authentication; so either `password` or `username:password` depending on how you configure the plugin.
- `channel` - The IRC channel to send notifications to; the `#` needs to be quoted, or you may also use `+`.
- `default_message` - Send the default message to the bot that contains the git ref, repo name, committer, SHA1, commit message, and a URL to the Actions run.
- `message` - A single custom message to send.
- `messages` - A JSON array consisting of multiple possible messages to send.
### Single Custom Message
To send a single IRC message, you may use the `message` parameter and use [message formatting directives](#message-formatting).
```yaml
- name: Send IRC notification
uses: allejo/supybot-notification-action@v1
if: always()
with:
status: ${{ job.status }}
hostname: 'supybothost.com:8090'
credentials: ${{ secrets.SUPYBOT_PASSWORD }}
channel: '#my-channel'
message: "I'm blue da ba dee da ba die"
```
### Send Multiple Messages
To send multiple messages to separate channels or messages based on conditions, use the `messages` parameter.
```yaml
- name: Send IRC notification
uses: allejo/supybot-notification-action@v1
if: always()
with:
status: ${{ job.status }}
hostname: 'supybothost.com:8090'
credentials: ${{ secrets.SUPYBOT_PASSWORD }}
messages: |
[
{
"condition": true,
"message": "I'm blue da ba dee da ba die",
"channel": "#channel-one"
},
{
"condition": true,
"message": "I'm also blue da ba dee da ba die",
"channel": "#channel-two"
}
]
```
The `channel` property may be omitted from the `messages` array **if** there the top-level `channel` parameter is provided.
## Message Formatting
You can control how the formatting of messages will appear with HTML-like markup (e.g. `content`).
### Colors
The following color directives are availale to change the color of messages:
- ``
- ``
- ``
- ``
- ``
- ``
- ``
- ``
- ``
- ``
- ``
- ``
- ``
- ``
- ``
- ``
- ``
For background colors, use the optional `:color` syntax. For example, if you would like to have a black background with white text, you would use `my white text with a black background`.
### Format
The following formatting directives are available:
- ``
- ``
- ``
- ``
## License
[MIT](./LICENSE)