dlang-bot for automated bugzilla, github, and trello references |
Clone or download
MartinNowak Merge pull request #215 from MartinNowak/bk_graphql
use buildkite's graphql API for more efficient querying
Latest commit 2b7e967 Nov 7, 2018

README.md

Dlang-Bot

Travis build status Codecov

dlang-bot

Features

Automated references

For example let's say you fixed Issue 16582 and make a PR for on GitHub. If one of your commits mentions the issue, e.g. like this Git commit message:

fix Issue 16582 - ParameterDefaults fails w/ scope parameter

The Dlang-Bot will do all the hard work of linking and referencing between Bugzilla, GitHub and Trello do for you.

GitHub

It would comment on GitHub with list of all mentioned issues and link them to Bugzilla:

dlang-bot-github

The first column of the table is the current status of the referenced issue. A means that the issue is only mentioned (i.e. the commit message doesn't contain "Fix") and the Bugzilla issue won't be auto-closed nor listed in the changelog as fixed:

image

Trello

For the Trello board it will also provide a reference:

dlang-bot-trello

And once a PR gets merged, the bot moves the linked Trello card to "Testing / Review".

Bugzilla

Once a PR has been merged (i.e. the commits got pushed to master or stable), GitHub's Bugzilla integration will automatically comment to Bugzilla with a regarding commit:

dlang-bot-bugzilla

Of course it will also automatically close the references issues (at least if either "fix", "close" or "address" occurs before the issue id).

Using this syntax is also very important because for the changelog generation, the git history will be used. Thus only if the Dlang-Bot has detected an issue and commented on your PR it can become part of the changelog.

In doubt, you can use e.g. Regex101 to validate your commit message.

Referencing multiple issues

It's possible to reference multiple issues, e.g. with "Fixes issues 17494, 17505, 17506" the Dlang-Bot would detect:

image

Of course, the Dlang-Bot will aggregate all mentioned issues over multiple commits.

Nerdy details

  • one can mention multiple issues in one commit and/or multiple commits
  • the exact RegEx is:
((close|fix|address)e?(s|d)? )?(ticket|bug|tracker item|issue)s?:? *([\d ,\+&#and]+)

(the GitHub Bugzilla integration and the Dlang-Bot use the same RegEx to parse git commit messages)

Auto-merge (WIP)

At the moment the Dlang-Bot supports merging via special auto-merge and auto-merge-squash labels. The later will perform a squashed merge of all commits in the PR into a single one.

A reviewer can toggle a PR for "auto-merge" by simply adding the auto-merge label (auto-merge-squash respectively).

Nerdy details

  • this relies on the "restricted branches" feature of GitHub (the Dlang-Bot will send the attempt to merge to the GitHub API)
  • once a new commit event occurs (push, synchronization) the Dlang-Bot will automatically remove set all auto-merge labels from the PR
  • for status events the GitHub API doesn't allow to get an information about the
  • the Dlang-Bot will then try to restart the PR on every new event.
  • concerning PR of the commit (thus all potential auto-merge PRs are checked)

Note: at the moment the Dlang-Bot doesn't store any authentication token, so it can't perform actions on behalf of others.

Warn about common mistakes

The Dlang-Bot will try to detect common mistakes and warn the contributor. Currently implemented:

  • Regression fixes doesn't target stable

image

Find stalled PRs

The Dlang-Bot goes over all pull requests every day and will label PRs:

Currently this feature is in alpha-mode and only enabled for Phobos.

Allow PR submitters to label their PRs

Dlang-Bot detects a pre-defined set of labels in the [] part of PR title and will label the PRs accordingly. Multiple labels are supported.

image

image

Currently the hard-coded set of detected labels is:

  • WIP
  • trivial

Send contributing advice message

For all repos in the dlang organization (and dlang-bots) Dlang-Bot provides contributing advice on a new PR:

image

Auto-label PRs

If a PR contains Bugzilla references, the Dlang-Bot will automatically add a respective label:

image

Of course, other issue types can be detected as well:

image

Using the Dlang-Bot for your project

The Dlang-Bot is run on Heroku and deploying your fork should be pretty straightforward. Just remember to set all environment variables. Alternatively feel free to ping and we can add your project to our hosted Dlang-Bot. The GitHub hook for your project should look roughly like this:

image

  • Payload URL: https://dlang-bot.herokuapp.com/github_hook (or your own)
  • Content type: application/json
  • Select at least these events (or all):
    • Label
    • Pull request
    • Pull request review
    • Pull request comment
    • Status

For auto-merge:

  • an respective label needs to be added (at the dlang repositories #d3d3d3 is used as a label color)
  • @dlang-bot (or your own bot) needs to have write access to the GitHub repo (GitHub's protected branches are ideal for this)

For example, dlang/phobos is configured as follows:

image

Missing a feature?

Is there a feature that you would love the Dlang-Bot to do? Then don't hesistate to let us know and open a new issue.