Class: Danger::DangerfileBitbucketCloudPlugin

Inherits:
Plugin
  • Object
show all
Defined in:
lib/danger/danger_core/plugins/dangerfile_bitbucket_cloud_plugin.rb

Overview

Handles interacting with Bitbucket Cloud inside a Dangerfile. Provides a few functions which wrap ‘pr_json` and also through a few standard functions to simplify your code.

Examples:

Warn when a PR is classed as work in progress


warn "PR is classed as Work in Progress" if bitbucket_cloud.pr_title.include? "[WIP]"

Declare a PR to be simple to avoid specific Danger rules


declared_trivial = (bitbucket_cloud.pr_title + bitbucket_cloud.pr_body).include?("#trivial")

Ensure that labels have been used on the PR


failure "Please add labels to this PR" if bitbucket_cloud.pr_labels.empty?

Ensure there is a summary for a PR


failure "Please provide a summary in the Pull Request description" if bitbucket_cloud.pr_body.length < 5

Only accept PRs to the develop branch


failure "Please re-submit this PR to develop, we may have already fixed your issue." if bitbucket_cloud.branch_for_base != "develop"

Highlight when a celebrity makes a pull request


message "Welcome, Danger." if bitbucket_cloud.pr_author == "dangermcshane"

Ensure that all PRs have an assignee


warn "This PR does not have any assignees yet." if bitbucket_cloud.pr_json[:reviewers].length == 0

Send a message with links to a collection of specific files


if git.modified_files.include? "config/*.js"
  config_files = git.modified_files.select { |path| path.include? "config/" }
  message "This PR changes #{ bitbucket_cloud.html_link(config_files) }"
end

Highlight with a clickable link if a Package.json is changed


warn "#{bitbucket_cloud.html_link("Package.json")} was edited." if git.modified_files.include? "Package.json"

See Also:

  • danger/danger

Bitbucket Cloud Misc collapse

PR Metadata collapse

PR Commit Metadata collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Plugin

all_plugins, clear_external_plugins, inherited, #method_missing

Constructor Details

#initialize(dangerfile) ⇒ DangerfileBitbucketCloudPlugin

Returns a new instance of DangerfileBitbucketCloudPlugin.



65
66
67
68
 
# File 'lib/danger/danger_core/plugins/dangerfile_bitbucket_cloud_plugin.rb', line 65

def initialize(dangerfile)
  super(dangerfile)
  @bs = dangerfile.env.request_source
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Danger::Plugin

Class Method Details

.instance_name ⇒ String

The instance name used in the Dangerfile

Returns:



61
62
63
 
# File 'lib/danger/danger_core/plugins/dangerfile_bitbucket_cloud_plugin.rb', line 61

def self.instance_name
  "bitbucket_cloud"
end

.new(dangerfile) ⇒ Object

So that this init can fail.



53
54
55
56
 
# File 'lib/danger/danger_core/plugins/dangerfile_bitbucket_cloud_plugin.rb', line 53

def self.new(dangerfile)
  return nil if dangerfile.env.request_source.class != Danger::RequestSources::BitbucketCloud
  super
end

Instance Method Details

#base_commit ⇒ String

The base commit to which the PR is going to be merged as a parent.

Returns:



131
132
133
 
# File 'lib/danger/danger_core/plugins/dangerfile_bitbucket_cloud_plugin.rb', line 131

def base_commit
  @bs.pr_json[:destination][:commit][:hash]
end

#branch_for_base ⇒ String

The branch to which the PR is going to be merged into.

Returns:



107
108
109
 
# File 'lib/danger/danger_core/plugins/dangerfile_bitbucket_cloud_plugin.rb', line 107

def branch_for_base
  @bs.pr_json[:destination][:branch][:name]
end

#branch_for_head ⇒ String

The branch to which the PR is going to be merged from.

Returns:



123
124
125
 
# File 'lib/danger/danger_core/plugins/dangerfile_bitbucket_cloud_plugin.rb', line 123

def branch_for_head
  @bs.pr_json[:source][:branch][:name]
end

#head_commit ⇒ String

The head commit to which the PR is requesting to be merged from.

Returns:



139
140
141
 
# File 'lib/danger/danger_core/plugins/dangerfile_bitbucket_cloud_plugin.rb', line 139

def head_commit
  @bs.pr_json[:source][:commit][:hash]
end

#pr_author ⇒ String

The username of the author of the Pull Request.

Returns:



99
100
101
 
# File 'lib/danger/danger_core/plugins/dangerfile_bitbucket_cloud_plugin.rb', line 99

def pr_author
  @bs.pr_json[:author][:username]
end

#pr_description ⇒ String Also known as: pr_body

The body text of the Pull Request.

Returns:



90
91
92
 
# File 'lib/danger/danger_core/plugins/dangerfile_bitbucket_cloud_plugin.rb', line 90

def pr_description
  @bs.pr_json[:description].to_s
end

#pr_json ⇒ Hash

The hash that represents the PR’s JSON. For an example of what this looks like see the [Danger Fixture’d one](raw.githubusercontent.com/danger/danger/master/spec/fixtures/bitbucket_cloud_api/pr_response.json).

Returns:

  • (Hash) 


74
75
76
 
# File 'lib/danger/danger_core/plugins/dangerfile_bitbucket_cloud_plugin.rb', line 74

def pr_json
  @bs.pr_json
end

#pr_link ⇒ String

A href that represents the current PR

Returns:



115
116
117
 
# File 'lib/danger/danger_core/plugins/dangerfile_bitbucket_cloud_plugin.rb', line 115

def pr_link
  @bs.pr_json[:links][:self][:href]
end

#pr_title ⇒ String

The title of the Pull Request.

Returns:



82
83
84
 
# File 'lib/danger/danger_core/plugins/dangerfile_bitbucket_cloud_plugin.rb', line 82

def pr_title
  @bs.pr_json[:title].to_s
end