bitbucket-slack-pr-hook

Receive Pull Requests notifications from Bitbucket and send them to Slack.

Features

As for 2014-09-26 we support all BitBucket's action types:

• created
• updated
• approve
• unapprove
• declined
• merged
• comment_created
• comment_deleted
• comment_updated

See Bitbucket's official docs: Pull Request POST hook management

Caveats

Bitbucket does not provide all necessary data in actions responses. For example, for a comment_* action we don't have the PR number, link nor name. So all we can do is something like "Comment posted for a PR" and then the snippet of the comment. But currently there's no way to know where did this comment came from.

Requirements

• Bitbucket repository with admin rights
• Slack Incoming Webhook Url: Get your Slack token from your "integrations" page
• Node.js OR Docker

Configuration

The configuration variables are set via environment variables and/or using .env file (environment variable takes preference over .env file if found). This makes it easy to run service also in Docker container.

If you want to use .env file, copy the example.env as .env and modify it as needed:

PORT=5000
SLACK_WEBHOOKURL=https://hooks.slack.com/services/.../.../...
SLACK_USERNAME = AwesomeBot
SLACK_CHANNEL = Repository

Note: Setting the SLACK_USERNAME or SLACK_CHANNEL will override the settings set on the incoming webhook integration page. If you want your team to edit any of these settings without redeploying, do not add them to your .env file.

Important: if you're going to use a .env file AND using Docker, edit it before building the Dockerfile.

When running the service in Docker container, the config values can be provided as parameters:

# Starts Docker container in daemonized mode
docker run -e PORT=5000 -e SLACK_TOKEN=123123 \
  -e SLACK_DOMAIN=company -e SLACK_CHANNEL=channel \
  -p 5000:5000 -d bitbucket-slack-pr-hook

You can also adjust the HEX Colors for notification attachments by adjusting any environment variables in the example below.

#Adjust HEX colors ie: #fff000

#Updated, Created
HEX_INFO = #3498db

#Declined
HEX_DANGER = #e74c3c

#Unapprove, Comment: Created, Comment: Deleted, Comment: Updated
HEX_WARNING = #f1c40f

#Merge & Approve
HEX_SUCCESS = #2ecc71

Installation

OR

You can install it in your own local infrastructure or in any other cloud service. Alternatively, you can build a Docker image and deploy as container

1. Set up a server address in your local infrastructure that will serve this application (eg: slackapi.mycompany.com or slackapi.heroku.com)
2. Clone/download this repo to your chosen server
3. Configure your application according to the "Configuration" section above
4. Install NodeJS if you don't have it
5. Run npm install in the app's root folder

Important note: make sure you don't have any firewall blocking the incoming TCP port (default is PORT 5000 as defined in the "Configuration" section above)

Installation using Docker

Service can also be installed & deployed using Docker containers, which makes it easy to setup the environment without worrying about the requirements.

1. Clone/download this repo

2. Install Docker (using system packages in Linux, in Windows or Mac OS X you can use Boot2docker)

3. Start Docker service (or boot2docker up)

4. Build the Docker image:

   Alternatively: npm run build-container

   docker build -t bitbucket-slack-pr-hook .

5. Start container with appropriate -e config parameters:

   docker run -e PORT=5000 -e SLACK_WEBHOOK=webhookurl
   -p 5000:5000 -d bitbucket-slack-pr-hook

6. Ensure the container is running (you should also be able to access the service using web browser: http://<dockerhost>:5000/).

   Note: In Linux the <dockerhost> is localhost, with Boot2docker use the IP reported by the command: boot2docker ip

Setting up the Bitbucket

1. In your main Bitbucket repository, go to Settings > Hooks and create a new Pull Request POST hook
2. Set up the URL as http://<server>:<port>{/<channel>}. * <server> is your host FQDN or its IP address * <port> is either 5000 or any other you defined in the configuration section * <channel> is an optional Slack channel where you want to receive this specific notifications - if it's not defined here it will use the one you defined in Configuration -section.

Use

Via plain node

1. Run npm start (or node server.js) to fire up the application (you can do node server.js & to run it as a daemon in your Linux box)

Via Docker

1. Run npm run build-container to build the container
2. Run npm run start-container to start the container and the server inside it
3. When needed, you can use npm run stop-container and npm run reload-container

Credits

This repo was inspired by: https://github.com/kfr2/bitbucket-pull-request-connector