joshghent / pullb0t

🤖Bot for posting new Gitlab Merge requests to a Slack Webhook with automatic JIRA integration

Pullb0t

A bot for posting new Gitlab Merge requests to a Slack Webhook with automatic JIRA integration

Developed with ❤️ by CloudCall

Features

• Automatically detect JIRA ticket numbers in the branch name or commit message
• Post all new non-WIP merge requests to a given Slack Webhook URL

Setup

Environment Variables

The bot requires a few config options. Here's how to get them

JIRA Details

It is recommended you create a new "bot" user account and assign it global admin privileges (so it can view all boards)

JIRA_URL="company.atlassian.net" - Note the lack of the http/https!
JIRA_USERNAME="bot" - the JIRA username used to query the API
JIRA_PASSWORD="password" - the JIRA password for the above user

Slack

1. Add the "Incoming Webhook" integration
2. Add a new configuration - setup where the webhook messages will go, and the user they will be posted as
3. Copy the "Webhook URL" on the page

Gitlab

GITLAB_URL="https://git.company.gitlab.com" - Just the URL for your git instance

Standard

1. Clone the project - $ git clone https://github.com/joshghent/pullb0t.git
2. Copy of the .env.example file and fill in the details
3. Run npm start!

Docker

docker run -d --restart always \ --name pullb0t \
  --env JIRA_URL="company.atlassian.net" \
  --env JIRA_USERNAME="botuser" \
  --env JIRA_PASSWORD="password" \
  --env SLACK_WEBHOOK_URL="HOOK_URL" \
  --env GITLAB_URL="GITLAB_URL" -p 1337:3000  joshghent/pullb0t:latest

Bugs

Please create a new issue here

License

MIT - CloudCall

Author

Josh Ghent on behalf of CloudCall

pullb0t's Issues

Add Dashboard

Dashboard should contain

• List of open PR's
• How long those PR's have been open

Add leaderboard

Add leaderboard to the UI of who has upvoted the most MR's, break down the report by all time or by this week

Add bitbucket support

Add settings

When they want the PR reminders to trigger by day of the week and time.

Add setup guide

Add analytics

Add Analytics tab to the UI with reports on average PR open time, upvote times (like when people approve PR's more)

Add github support

Fix @here not being picked up

Think we can enable this with "link_names" option

Add verification of the X-Gitlab-Token

If a GITHUB_SECRET is set in env then check if it matches the Secret token that is passed in the X-Gitlab-Token header that is sent with new webhook messages

Add Lambda wrapper support

Create way to bring back old MR's

Run a job scheduler backed by Mongo

Changes:

• New MR's should be recorded in Mongo to know how many times we've posted the MR
• If an MR is found in the Mongo DB already then increment the number of times it has been posted
• Every 8 hours, run a job that
  • Goes through the DB and clean all the ones that have been upvoted or merged and are less than a month old and it has been posted less than 5 times
  • Sends any that haven't been cleared out to the webhook again for processing

Dockerize