docs/usage/bitbucket_cloud.html.md
To use Danger JS with BitBucket Cloud: you'll need to create a new account for Danger to use, then set the following environment variables on your CI:
You could use either username with password, OAuth key with OAuth secret or repository access token.
For username and password, you need to set.
DANGER_BITBUCKETCLOUD_USERNAME = The username for the account used to comment, as shown on
https://bitbucket.org/account/DANGER_BITBUCKETCLOUD_PASSWORD = The password for the account used to comment, you could use
App passwords
with Read Pull Requests and Read Account Permissions.For OAuth key and OAuth secret, you can get them from.
Navigate to Settings > OAuth > Add consumer
Put https://bitbucket.org/site/oauth2/authorize for Callback URL, and enable Read Pull requests, and Read Account
Permission.
DANGER_BITBUCKETCLOUD_OAUTH_KEY = The consumer key for the account used to comment, as show as Key on the website.
DANGER_BITBUCKETCLOUD_OAUTH_SECRET = The consumer secret for the account used to comment, as show as Secret on the
website.
For repository access token, what you need to create one is:
Then in your Dangerfiles you will have a fully fleshed out danger.bitbucket_cloud object to work with. For example:
import { danger, warn } from "danger"
if (danger.bitbucket_cloud.pr.title.includes("WIP")) {
warn("PR is considered WIP")
}
The DSL is expansive, you can see all the details inside the [Danger JS Reference][ref], but the TLDR is:
danger.bitbucket_cloud.
/** The pull request and repository metadata */
metadata: RepoMetaData
/** The PR metadata */
pr: BitBucketCloudPRDSL
/** The commits associated with the pull request */
commits: BitBucketCloudCommit[]
/** The comments on the pull request */
comments: BitBucketCloudPRComment[]
/** The activities such as OPENING, COMMENTING, CLOSING, MERGING or UPDATING a pull request */
activities: BitBucketCloudPRActivity[]