haiku / irccat-resource

A concourse resource to send a notification to an irccat server

IRCCat Notification Resource

This Concourse resource reaches out to a remote server running irccat to send build notifications to IRC channels.

Leveraging a service like irccat from concourse allows:

• A notification bot to idle in IRC channels (reducing spammy joins/quits)
• Color IRC messages

Resource Type Configuration

resource_types:
- name: irccat-resource
  type: docker-image
  source:
    repository: haiku/irccat-resource
    tag: latest

Source Configuration

resources:
- name: irccat
  type: irccat-resource
  source:
    uri: https://irccat.myserver.com
    secret: "MyPassword"

Behavior

out: Push a message to an IRCCat server over HTTP

Create or delete a webhook using the configured parameters.

Parameters

- put: irccat
  resource: irccat-resource
  params:
    message: %GREEN howdy! %NORMAL

Development

Prerequisites

• Docker

Making changes

The Concourse entrypoints are in bin/check, bin/in, and bin/out. You can add functionality to these files directly, or you can require additional supporing files.

Building your changes

make

To use the newly built image, push it to a Docker repository which your Concourse pipeline can access and configure your pipeline to use it:

make push

Contributing

Please read the CONTRIBUTING.md file to learn the process for submitting changes to this repo.

Donations

If you appreciate this tool, please consider making a donation to Haiku, Inc.

License

This project is licensed under the MIT license.

Reference

• Implementing a Concourse Resource
• Concourse Community Resources