Skip to content

Latest commit

 

History

History
72 lines (46 loc) · 2.74 KB

setup_for_org.md

File metadata and controls

72 lines (46 loc) · 2.74 KB
Raw

Setting up a Peril server

I'm assuming you're going to use heroku. Peril is set up for being used in Docker, but it'll require a bit of time before I'm confident using it myself, and thus writing tutorials for it.

Sidenote: here's a note with terminology as it's a little tricky.

So, you will need to have:

  • A unique GitHub [integration][]
  • A repo where you can keep Peril settings
  • A heroku instance for Peril

Creating your integration

You would go to the URL (with your org):

https://github.com/organizations/[my_org]/settings/integrations

Then create a new integration (use peril-[my-org], there is a global namespace.) At the bottom is the option to only allow this integration to run on your org, you want this ticked probably.

Once this is created, you need to install the integration on your GitHub org. [explain process for this]. Also download the integration github signing key and keep track of the integration ID, you'll need this later.

You can do the same thing on your user account too BTW.

Repo Settings

You need to have a repo which Peril has access to. This repo needs to have a settings JSON file. For now, let's use some example dangerfiles:

"settings": {
  "onlyForOrgMembers": false
},
"rules": {
  "pull_request": "orta/example-peril@pr.ts",
  "issue": "orta/example-peril@issue.ts"
},
"repos" : {
  "orta/ORStackView": {
    "issue.created": "lock_old_issues.ts"
  }
}

This JSON file is split into 3 parts:

  • Settings for Peril
  • Rules for the organization
  • Rules per repo

This setup will:

  • Listen for the event "pull_request", and will pull "pr.ts" from the repo: orta/example-peril.
  • Listen for the event "issue", and will pull "issue.ts" from the repo: orta/example-peril.
  • Listen for the event "issue" event, and only if the action is "created" and will pull "lock_old_issues.ts" from the same repo: orta/ORStackView. So it would ignore issue updates or deletes.

You can actually use orta/example-peril BTW, I have some dummy Dangerfiles on that repo exactly for this purpose. Save the above JSON as peril-settings.json. Add that to a repo, push it to master on your GitHub remote.

When you make updates to this file, you need to restart your Peril server.

Heroku

Ok, so, you need a heroku account. So sign up if you've not. This post will wait fr you.

Click: Deploy . It's the "auto-heroku-ize" button that will walk you through setting up the environment variables for running Danger for just one org.

Prove it works

If you open a PR on any repo, Peril should comment on your PR.

If it doesn't, run heroku logs --app [my_heroku_peril_app] and see if I missed something obvious.