/step-slack

Slack notification step for wercker. Post build and deploy status to your Slack channel

Primary LanguageShellMIT LicenseMIT

step-slack

A slack notifier written in bash and curl. Make sure you create a Slack webhook first (see the Slack integrations page to set one up).

wercker status

Options

  • url The Slack webhook url
  • username Username of the notification message
  • channel (optional) The Slack channel (excluding #)
  • icon_url (optional) A url that specifies an image to use as the avatar icon in Slack
  • notify_on (optional) If set to failed, it will only notify on failed builds or deploys.
  • branch (optional) If set, it will only notify on the given branch
  • custom_message (optional) If set, it will override classic build/deploy status.
  • custom_color (optional) If set, it will override green/danger color with custom one.

Example

build:
    after-steps:
        - slack-notifier:
            url: $SLACK_URL
            channel: notifications
            username: myamazingbotname
            branch: master

If you want to post a slack message for example when the build or deploy starts, you can use custom_message and custom_color variables

Example

deploy:
   steps:
     - slack-notifier:
       url: $SLACK_URL
       channel: notifications
       custom_message: Deploying $WERCKER_GIT_BRANCH to $WERCKER_DEPLOYTARGET_NAME ($WERCKER_DEPLOY_URL)
       custom_color: #439fe0

The url parameter is the slack webhook that wercker should post to. You can create an incoming webhook on your slack integration page. This url is then exposed as an environment variable (in this case $SLACK_URL) that you create through the wercker web interface as deploy pipeline variable.

License

The MIT License (MIT)

Changelog

1.2.0

  • added branch option

1.1.0

  • channel is now optional (wercker/step-slack#5)

1.0.0

  • Initial release