Note (August 26th, 2022)

This project is being shut down. See #41 for details.

What this is

A webhook that can automatically create Bugzilla attachments when new GitHub Pull Requests are created.

It does this by looking at the git commit message of a newly created PR for a Bugzilla bug ID in the form "bug n". Then if that bug can be found (and doesn't already have a link) it creates an attachment which is a link that redirects to the Pull Request on GitHub.

For Mozilla projects

The code here is just the source code that any organization can use.

There is an instance of this installed on the Mozilla corporate Heroku account and it's hardwired to use https://bugzilla.mozilla.org and the account set up is exclusive to Mozilla projects using bugzilla.mozilla.org.

To use it in your project you need the password. See the Mana documentation page.

To get insight into GitHub projects that use this project you can search by user activity which gives you an idea of the projects.

How to use

To enable this you need to go into your GitHub project's Settings and click Webhooks. The click the Add webhook button (top right corner).

There, type in the the following:

Payload URL: https://github-bugzilla-pr-linker.herokuapp.com/postreceive

Content type: application/x-www-form-urlencoded

Secret: See Mozilla Mana page

Which events would you like to trigger this webhook? Click the Let me select individual events. option. Check the Pull request checkbox and uncheck all others.

How to run locally

First create a .env file:

cp .env-dist .env

Edit that .env file with real stuff if you have it.

Create a Python 3 virtualenv and install the dependencies:

pip install -r requirements.txt

Now start it:

FLASK_DEBUG=1 FLASK_APP=app.app flask run

How to run tests

Install the dependencies for running tests:

pip install -r dev-requirements.txt

Run the tests:

pip install -e .
FLASK_APP=app.app pytest

How to contribute

All Python code needs to be Black and this is enforced in TravisCI. The same is true for flake8 .

For local development, it's best to use therapist which is already listed in dev-requirements.txt. To install a pre-commit hook that checks for flake8 and black slip-ups. You install it like this:

pip install -r dev-requirements.txt
therapist install

If you're eager to test if all the linting is passing you can run:

therapist run

Which will check the files you have touched. This is basically what the pre-commit installed does except its exits can preven the git commit.

To check all files run:

therapist run --use-tracked-files

If you don't have auto-matic Black formatting in your editor you can run:

therapist run --fix

Which will format all the files you have touched.

How to run with Docker

TODO!

License

MPL2

Heroku

At the moment this Flask app is deployed on Heroku, using the Mozilla corporate account, under the name github-bugzilla-pr-linker.

Sentry

To enable Sentry error reporting you simply need to set an environment variable called SENTRY_DSN with the DSN string. Don't leave it as an empty string.