Skip to content

Commit

Permalink
Added docs properly
Browse files Browse the repository at this point in the history
  • Loading branch information
acecilia committed Jul 17, 2018
1 parent 6028aa1 commit c874b80
Showing 1 changed file with 18 additions and 6 deletions.
24 changes: 18 additions & 6 deletions docs/usage/bitbucket_server.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ order: 4
blurb: An overview of using Danger with BitBucket Server, and some examples
---

To use Danger JS with BitBucket Server: you'll need to create a new account for Danger to use,
then set the following environment variables on your CI:
To use Danger JS with BitBucket Server: you'll need to create a new account for Danger to use, then set the following
environment variables on your CI:

* `DANGER_BITBUCKETSERVER_HOST` = The root URL for your server, e.g. `https://bitbucket.mycompany.com`.
* `DANGER_BITBUCKETSERVER_USERNAME` = The username for the account used to comment.
Expand All @@ -23,8 +23,7 @@ if (danger.bitbucket_server.pr.title.includes("WIP")) {
}
```

The DSL is expansive, you can see all the details inside the [Danger JS Reference][ref],
but the TLDR is:
The DSL is expansive, you can see all the details inside the [Danger JS Reference][ref], but the TLDR is:

```ts
danger.bitbucket_server.
Expand Down Expand Up @@ -72,6 +71,19 @@ if (hasGIF) {
}
```

Plus any other example you can find that uses GitHub, will probably work in BitBucket Server, with a bit of DSL translation.
Plus any other example you can find that uses GitHub, will probably work in BitBucket Server, with a bit of DSL
translation.

Our BitBucket Server support is still pretty new, so we'd love to see improvements and PRs to help make it work for everyone.
Our BitBucket Server support is still pretty new, so we'd love to see improvements and PRs to help make it work for
everyone.

In addition, it is possible to specify a proxy to be used for the requests using environmental variables. This is useful
for debugging:

```ts
export NODE_TLS_REJECT_UNAUTHORIZED=0 # Avoid certificate error

export http_proxy=http://127.0.0.1:8080
or
export https_proxy=https://127.0.0.1:8080
```

0 comments on commit c874b80

Please sign in to comment.