class Danger::DangerfileVSTSPlugin

Handles interacting with VSTS 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 vsts.pr_title.include? "[WIP]"

@example Declare a PR to be simple to avoid specific Danger rules

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

@example Ensure there is a summary for a PR

failure "Please provide a summary in the Pull Request description" if vsts.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 vsts.branch_for_base != "develop"

@example Highlight when a celebrity makes a pull request

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

@example Ensure that all PRs have an assignee

warn "This PR does not have any assignees yet." unless vsts.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 #{ vsts.markdown_link(config_files) }"
end

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

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

@example Note an issue with a particular line on a file using the L[num] syntax, e.g. ‘#L23`

linter_json = `my_linter lint "file"`
results = JSON.parse linter_json
unless results.empty?
  file, line, warning = result.first
  warn "#{vsts.markdown_link("#{file}#L#{line}")} has linter issue: #{warning}."
end

@see danger/danger @tags core, vsts

Public Class Methods

instance_name() click to toggle source

The instance name used in the Dangerfile @return [String]

# File lib/danger/danger_core/plugins/dangerfile_vsts_plugin.rb, line 66
def self.instance_name
  "vsts"
end
new(dangerfile) click to toggle source

So that this init can fail.

Calls superclass method
# File lib/danger/danger_core/plugins/dangerfile_vsts_plugin.rb, line 57
def self.new(dangerfile)
  return nil if dangerfile.env.request_source.class != Danger::RequestSources::VSTS

  super
end
new(dangerfile) click to toggle source
Calls superclass method
# File lib/danger/danger_core/plugins/dangerfile_vsts_plugin.rb, line 70
def initialize(dangerfile)
  super(dangerfile)
  @source = dangerfile.env.request_source
end

Public Instance Methods

base_commit() click to toggle source

@!group PR Commit Metadata The base commit to which the PR is going to be merged as a parent. @return [String]

# File lib/danger/danger_core/plugins/dangerfile_vsts_plugin.rb, line 139
def base_commit
  @source.pr_json[:lastMergeTargetCommit][:commitId].to_s
end
branch_for_base() click to toggle source

@!group PR Commit Metadata The branch to which the PR is going to be merged into. @return [String]

# File lib/danger/danger_core/plugins/dangerfile_vsts_plugin.rb, line 112
def branch_for_base
  branch_name(:targetRefName)
end
branch_for_head() click to toggle source

@!group PR Commit Metadata The branch to which the PR is going to be merged from. @return [String]

# File lib/danger/danger_core/plugins/dangerfile_vsts_plugin.rb, line 131
def branch_for_head
  branch_name(:sourceRefName)
end
head_commit() click to toggle source

@!group PR Commit Metadata The head commit to which the PR is requesting to be merged from. @return [String]

# File lib/danger/danger_core/plugins/dangerfile_vsts_plugin.rb, line 147
def head_commit
  @source.pr_json[:lastMergeSourceCommit][:commitId].to_s
end
pr_author() click to toggle source

@!group PR Metadata The username of the author of the Pull Request. @return [String]

# File lib/danger/danger_core/plugins/dangerfile_vsts_plugin.rb, line 104
def pr_author
  @source.pr_json[:createdBy][:displayName].to_s
end
pr_body()
Alias for: pr_description
pr_description() click to toggle source

@!group PR Metadata The body text of the Pull Request. @return [String]

# File lib/danger/danger_core/plugins/dangerfile_vsts_plugin.rb, line 95
def pr_description
  @source.pr_json[:description].to_s
end
Also aliased as: pr_body
pr_json() click to toggle source

@!group VSTS 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/vsts_api/pr_response.json). @return [Hash]

# File lib/danger/danger_core/plugins/dangerfile_vsts_plugin.rb, line 79
def pr_json
  @source.pr_json
end
pr_title() click to toggle source

@!group PR Metadata The title of the Pull Request. @return [String]

# File lib/danger/danger_core/plugins/dangerfile_vsts_plugin.rb, line 87
def pr_title
  @source.pr_json[:title].to_s
end

Private Instance Methods

branch_name(key) click to toggle source
# File lib/danger/danger_core/plugins/dangerfile_vsts_plugin.rb, line 186
def branch_name(key)
  repo_matches = @source.pr_json[key].to_s.match(%r{refs/heads/(.*)})
  repo_matches[1] unless repo_matches.nil?
end