class Danger::DangerfileBitbucketCloudPlugin
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.
@example 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]"
@example Declare a PR
to be simple to avoid specific Danger
rules
declared_trivial = (bitbucket_cloud.pr_title + bitbucket_cloud.pr_body).include?("#trivial")
@example Ensure that labels have been used on the PR
failure "Please add labels to this PR" if bitbucket_cloud.pr_labels.empty?
@example 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
@example 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"
@example Highlight when a celebrity makes a pull request
message "Welcome, Danger." if bitbucket_cloud.pr_author == "dangermcshane"
@example Ensure that all PRs have an assignee
warn "This PR does not have any assignees yet." if bitbucket_cloud.pr_json[:reviewers].length == 0
@example 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
@example 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 danger/danger @tags core, bitbucket_cloud
Public Class Methods
Source
# File lib/danger/danger_core/plugins/dangerfile_bitbucket_cloud_plugin.rb, line 60 def self.instance_name "bitbucket_cloud" end
The instance name used in the Dangerfile
@return [String]
Source
# File lib/danger/danger_core/plugins/dangerfile_bitbucket_cloud_plugin.rb, line 51 def self.new(dangerfile) return nil if dangerfile.env.request_source.class != Danger::RequestSources::BitbucketCloud super end
So that this init can fail.
Source
# File lib/danger/danger_core/plugins/dangerfile_bitbucket_cloud_plugin.rb, line 64 def initialize(dangerfile) super(dangerfile) @bs = dangerfile.env.request_source end
Public Instance Methods
Source
Source
Source
Source
Source
# File lib/danger/danger_core/plugins/dangerfile_bitbucket_cloud_plugin.rb, line 89 def pr_description @bs.pr_json[:description].to_s end
@!group PR
Metadata The body text of the Pull Request. @return [String]
Source
# File lib/danger/danger_core/plugins/dangerfile_bitbucket_cloud_plugin.rb, line 73 def pr_json @bs.pr_json end
@!group Bitbucket Cloud Misc 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). @return [Hash]
Source
Source
# File lib/danger/danger_core/plugins/dangerfile_bitbucket_cloud_plugin.rb, line 81 def pr_title @bs.pr_json[:title].to_s end
@!group PR
Metadata The title of the Pull Request. @return [String]