There are 5 steps involved in getting Danger running:
- Include Danger.
- Creating a Dangerfile and adding a few simple rules.
- Creating an account for Danger to use.
- Setting up an access token for Danger with that account.
- Setting up Danger to run on your CI.
We recommend you install Danger via Bundler + a Gemfile. This means that your version of Danger and your plugins are all versioned correctly. You are in control of how and when your dependencies are updated. If you’d like to learn more about Bundler, check out this guide.
If you have an existing Gemfile, add
gem 'danger' or
gem 'danger-gitlab' to it. If you don’t, run
bundle init in your project root, and edit the freshly-minted Gemfile.
Bundler is a dependency manager for Ruby which uses a Gemfile to define all of the Ruby projects you want to use. To get started type in
bundler init in your project folder.
This creates your
Gemfile. Open this up in your editor, then replace the
#gem 'rails' with the gem above. Then run
bundle install inside your project folder.
Easy mode - run:
bundle exec danger init - this will guide you through the next four steps, offering useful advice specific to your setup. If you would like to understand how all of the pieces come together, read on:
#Creating a Dangerfile
Create an empty file named
Dangerfile. The file is written in Ruby, but your text editor might not recognize it as such, so you may need to set the syntax highlighting manually (unless you’re using VS Code). To get started, we would recommend a simple “Hello World.”
message("Hello, this worked")
#Creating a bot account for Danger to use
This is optional. Pragmatically, you want to do this though.
- Bitbucket Server
In order to get the most out of Danger, we recommend giving her the ability to post comments in your Pull Requests. This is a regular GitHub account, but depending on whether you are working on a private or public project, you will want to give different levels of access to this bot. You are allowed to have one bot per GitHub account.
To get started, open https://github.com in a private browser session.
Do not add the bot to your repo or to your organization.
#Closed Source Projects
Add the bot to your repo or to your organization. The bot requires permission level “Write” to be able to set a PR’s status. Note that you should not re-use this bot for OSS projects.
#Setting up an Access Token
Here’s the link, you should open this in the private session where you just created the new GitHub account. Again, the rights that you give to the token depend on the openness of your projects. You’ll want to save for later, when you add a
DANGER_GITHUB_API_TOKEN to your CI.
#Tokens for OSS Projects
We recommend giving the token the smallest scope possible. This means just
public_repo, this scope is still ideally too much but this account shouldn’t have any access to other repos or organizations - so malicious use of the token is scoped to making new repos on it, or writing comments on other OSS projects. Because the token can be quite easily be extracted from the CI environment, this minimizes the chance for bad actors to cause chaos with it.
#Tokens for Closed Source Projects
We recommend giving access to the whole
repo scope, and its children.
You can work with GitHub Enterprise by setting 2 environment variables:
DANGER_GITHUB_HOST to the host that GitHub is running on.
DANGER_GITHUB_API_BASE_URL to the host that the GitHub Enterprise API is reachable on.
To get the most out of Danger, we recommend giving her the ability to post comments in your Merge Requests. This is a regular GitLab account, but depending on whether you are working on a private or public project, you will want to give different levels of access to this bot.
To get started, open https://gitlab.com (or your GitLab instance) in a private browser session.
Do not add the bot to your project or to your group.
#Closed Source Projects
Add the bot to your private project or to your private group with the “Reporter” permission level. Note that you should not re-use this bot for OSS projects. As the access token you use could be extracted and would give access to your closed source projects.
#Setting up an Access Token
Here’s the link, you should open this in the private session where you have just created the new GitLab account. You’ll want to copy the token for later, when you add a
DANGER_GITLAB_API_TOKEN to your CI.
If you are self hosting GitLab, you’ll need to generate an access token for the bot user. You can find the section under “Access Tokens” in the bot user’s profile.
To let Danger know the API details around your custom setup, you need to set two env variables:
DANGER_GITLAB_HOST to the host that GitLab is running on.
DANGER_GITLAB_API_BASE_URL to the host that the GitLab API is reachable on.
To get the most out of Danger, we recommend giving her the ability to post comments in your Pull Requests. This is a regular Bitbucket account, that exists just for Danger.
#Setting up the Environment Variables
To get set up, you will need to provide
DANGER_BITBUCKETSERVER_PASSWORD and your
DANGER_BITBUCKETSERVER_HOST into the environment.
You will also want to ensure that
ghprbPullId is added into the environment with the Pull Request
id so that Danger can use your Bitbucket Server’s API. As of right now, only Jenkins is supported for Bitbucket Server, we’re open to improvements there, for sure.
With your ENV vars set up, you can edit your job to add
bundle exec danger at the build action.
Continuous Integration is the process of regularly running tests and generating metrics for a project. It is where you can ensure that the code you are submitting for review is passing on all of the tests. You commonly see this as green or red dots next to commits.
Danger is built to run as a part of this process, so you will need to have this set up as a pre-requisite.
#Setting up Danger to run on your CI