README.md

IRC Notification Resource for Concourse

Sends messages to an IRC channel from a Concourse CI pipeline.

Resource configuration

These parameters go into the source fields of the resource type.

Required

• server: The IRC server fully qualified domain name.
• port: The TCP port on which to connect.
• channel: The name of the channel to be notified (should include leading #, e.g., #go-nuts).
• user: The username used for authentication.
• password: The password used for authentication.

Optional

• usetls: [default: true] Use TLS (a.k.a. SSL) to encrypt your connection to the IRC server.
• join: [default: false] Join the channel before sending the message (and leave afterwards). This is necessary if the channel mode includes +n.
• debug: [default: false] Emit debugging messages on stderr. ⚠__WARNING__⚠: Setting this to true will log the password to stderr, so USE WITH CAUTION.

Behaviour

check, in

This resource only supports the put phase of a job plan, so these are no-ops.

out

Connects to the IRC server, authenticates, and sends the given message to the named channel via a PRIVMSG command.

Parameters

Exactly one of the following parameters must be present:

• message: The text of the notification to be sent.
• message_file: The path to a file containing the text of the notification to be sent.

Any Concourse metadata in the message string or in the text contents of message_file will be evaluated prior to sending the message. If the notification text contains newlines then it will be split into multiple IRC message sends.

Note also that the pseudo-metadata BUILD_URL will expand to:

${ATC_EXTERNAL_URL}/teams/${BUILD_TEAM_NAME}/pipelines/${BUILD_PIPELINE_NAME}/jobs/${BUILD_JOB_NAME}/builds/${BUILD_NAME}

Example usage

resource_types:
- name: irc-notification
  type: docker-image
  source:
    repository: flavorjones/irc-notification-resource

resources:
- name: random-channel
  type: irc-notification
  source:
    server: chat.freenode.net
    port: 7070
    channel: "#random"
    user: randobot1337
    password: # your password here

jobs:
- name: post-that-message-to-irc
  plan:
  - put: random-channel
    params:
      message: >
        This is a message about build ${BUILD_ID}, view it at ${BUILD_URL}

Contributing

Pull requests are welcome, as are Github issues opened to discuss bugs or desired features.

Development and Running the tests

Requires

• go >= 1.14
• make

make test

Or if you prefer to use Docker, using the Dockerfile, which runs the tests as part of the image build:

make docker

License

Distributed under the MIT license, see the LICENSE file.