Skip to content

Latest commit

 

History

History
28 lines (26 loc) · 1.82 KB

terminology.md

File metadata and controls

28 lines (26 loc) · 1.82 KB

Terminology

This gets confusing, so I'll try map out all the terms used inside Peril.

  • Danger - the nodejs CLI tool that runs your code for cultural rules.
  • Peril - the hosted server that takes GitHub events and runs danger against them.
  • GitHub - currently the only core review site that Danger supports, and so also the only one for Peril.
  • Org - A GitHub Organization. A collection of users and repos.
  • Repo - A GitHub Repo.
  • GitHub App - A GitHub API type, it allows external apps to get a feed of events and can have "[bot]" accounts.
  • Installation - When a GitHub user adds a GitHub app to an org, or a set of repos. Each repo (or one for all repos) is an installation.
  • [bot] account - An account for an integration, it has the word [bot] next to its name.
  • Event - Any user interaction that happens on GitHub, within the context of your org. See this link for all events.
  • Action - An event can have a sub-action, so a "issues" event can have the actions of "created", "updated", etc.
  • Staging/Prod - Orta's hosted version of Peril, that handles multiple settings repos for many org/users. It is Mongo based, and uses a Docker Runner
  • JSON based host - A Peril instance that uses a single JSON repo, it doesn't keep a copy of the installation inside the MongoDB
  • Mongo based host - A Peril instance that does not use DATABASE_JSON_FILE, but instead works via GitHub webhooks and the GraphQL API
  • Inline Danger Runner - When the dangerfile is eval'd inside the same process as Peril, you must trust all code in this situation.
  • Docker Danger Runner - Using Peril as a docker container, from the runner tag on dangersystems/peril to evaluate JS code in a safe, fresh environment each time