Rangefinder GitHub integration

Rangefinder is a tool that helps predict the downstream impact of breaking file changes. This GitHub integration allows us to tie it to pull requests and provide impact prediction reports as comments when a PR is filed.

It's still fairly young in its development, so please don't hesitate to file issues either here or on the Rangefinder tool itself.

See my blog post for more information on this tool.

Installation

Visit its GitHub app page.
Click Install App in the sidebar.
Select your name or an organization you belong to.
Then select the repositories you'd like to enable the app on.

install app select repos

Running your own server

This is a fairly complex configuration. You'll need to register both Google Cloud and GitHub apps, and configure Rangefinder itself.

Register a new GitHub app following the instructions at:
- https://developer.github.com/apps/building-github-apps/creating-a-github-app/
Generate a new GitHub private key:
- https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/
Create a new Google Cloud service account:
- https://cloud.google.com/docs/authentication/getting-started

Use that information to generate your configuration file. The :gcloud key will be passed directly through to the Rangefinder config. If you're using the official Puppet public BigQuery dataset, then you should use the values provided in the example below.

The configuration file location defaults to the first found of

~/.rangefinder.conf
/etc/rangefinder/config.yaml

Example configuration:

---
:gcloud:
  :dataset: community
  :project: dataops-puppet-public-data
  :keyfile: <your service account credentials>
:github:
  :app_identifier: <your app id>
  :private_key_file: <your private key file>
  :webhook_secret: <your webhook secret>

Limitations

This is super early in development and has not yet been battle tested.

Disclaimer

I take no liability for the use of this tool.

Contact

[email protected]