Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dbgrandi committed Apr 29, 2018
1 parent 7e15520 commit 81525f2
Showing 1 changed file with 15 additions and 8 deletions.
23 changes: 15 additions & 8 deletions source/ci_source/providers/Screwdriver.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,27 @@ import { ensureEnvKeysExist, ensureEnvKeysAreInt } from "../ci_source_helpers"
/**
* ### CI Setup
*
* With BuildKite you run the server yourself, so you will want to run it as a part of your build process.
* It is common to have build steps, so we would recommend adding this to your scrip:
*
* ``` shell
* echo "--- Running Danger"
* bundle exec danger
* ```
* Install dependencies and add a danger step to your screwdriver.yaml:
* ``` yml
* jobs:
* danger:
* requires: [~pr, ~commit]
* steps:
* - setup: yarn install
* - danger: yarn danger ci
* secrets:
* - DANGER_GITHUB_API_TOKEN
* ```
*
* ### Token Setup
*
* Add the `DANGER_GITHUB_API_TOKEN` to your pipeline env as a
* [build secret](https://docs.screwdriver.cd/user-guide/configuration/secrets)
*
* #### GitHub
*
* As this is self-hosted, you will need to add the `DANGER_GITHUB_API_TOKEN` to your build user's ENV. The alternative
* is to pass in the token as a prefix to the command `DANGER_GITHUB_API_TOKEN="123" bundle exec danger`.
* is to pass in the token as a prefix to the command `DANGER_GITHUB_API_TOKEN="123" yarn danger ci`.
*/
export class Screwdriver implements CISource {
constructor(private readonly env: Env) {}
Expand Down

0 comments on commit 81525f2

Please sign in to comment.