Class: Dependabot::PullRequestCreator

Inherits:
Object
  • Object
show all
Defined in:
lib/dependabot/pull_request_creator.rb,
lib/dependabot/pull_request_creator/azure.rb,
lib/dependabot/pull_request_creator/github.rb,
lib/dependabot/pull_request_creator/gitlab.rb,
lib/dependabot/pull_request_creator/labeler.rb,
lib/dependabot/pull_request_creator/codecommit.rb,
lib/dependabot/pull_request_creator/branch_namer.rb,
lib/dependabot/pull_request_creator/commit_signer.rb,
lib/dependabot/pull_request_creator/message_builder.rb,
lib/dependabot/pull_request_creator/pr_name_prefixer.rb,
lib/dependabot/pull_request_creator/message_builder/issue_linker.rb,
lib/dependabot/pull_request_creator/message_builder/link_and_mention_sanitizer.rb

Defined Under Namespace

Classes: Azure, BranchNamer, Codecommit, CommitSigner, Github, Gitlab, Labeler, MessageBuilder, NoHistoryInCommon, PrNamePrefixer, RepoArchived, RepoDisabled, RepoNotFound

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(source:, base_commit:, dependencies:, files:, credentials:, pr_message_footer: nil, custom_labels: nil, author_details: nil, signature_key: nil, commit_message_options: {}, vulnerabilities_fixed: {}, reviewers: nil, assignees: nil, milestone: nil, branch_name_separator: "/", branch_name_prefix: "dependabot", label_language: false, automerge_candidate: false, github_redirection_service: "github-redirect.dependabot.com", custom_headers: nil, require_up_to_date_base: false) ⇒ PullRequestCreator

Returns a new instance of PullRequestCreator.



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/dependabot/pull_request_creator.rb', line 28

def initialize(source:, base_commit:, dependencies:, files:, credentials:,
               pr_message_footer: nil, custom_labels: nil,
               author_details: nil, signature_key: nil,
               commit_message_options: {}, vulnerabilities_fixed: {},
               reviewers: nil, assignees: nil, milestone: nil,
               branch_name_separator: "/", branch_name_prefix: "dependabot",
               label_language: false, automerge_candidate: false,
               github_redirection_service: "github-redirect.dependabot.com",
               custom_headers: nil, require_up_to_date_base: false)
  @dependencies               = dependencies
  @source                     = source
  @base_commit                = base_commit
  @files                      = files
  @credentials                = credentials
  @pr_message_footer          = pr_message_footer
  @author_details             = author_details
  @signature_key              = signature_key
  @commit_message_options     = commit_message_options
  @custom_labels              = custom_labels
  @reviewers                  = reviewers
  @assignees                  = assignees
  @milestone                  = milestone
  @vulnerabilities_fixed      = vulnerabilities_fixed
  @branch_name_separator      = branch_name_separator
  @branch_name_prefix         = branch_name_prefix
  @label_language             = label_language
  @automerge_candidate        = automerge_candidate
  @github_redirection_service = github_redirection_service
  @custom_headers             = custom_headers
  @require_up_to_date_base    = require_up_to_date_base

  check_dependencies_have_previous_version
end

Instance Attribute Details

#assignees ⇒ Object (readonly)

Returns the value of attribute assignees



20
21
22
 
# File 'lib/dependabot/pull_request_creator.rb', line 20

def assignees
  @assignees
end

#author_details ⇒ Object (readonly)

Returns the value of attribute author_details



20
21
22
 
# File 'lib/dependabot/pull_request_creator.rb', line 20

def author_details
  @author_details
end

#base_commit ⇒ Object (readonly)

Returns the value of attribute base_commit



20
21
22
 
# File 'lib/dependabot/pull_request_creator.rb', line 20

def base_commit
  @base_commit
end

#branch_name_prefix ⇒ Object (readonly)

Returns the value of attribute branch_name_prefix



20
21
22
 
# File 'lib/dependabot/pull_request_creator.rb', line 20

def branch_name_prefix
  @branch_name_prefix
end

#branch_name_separator ⇒ Object (readonly)

Returns the value of attribute branch_name_separator



20
21
22
 
# File 'lib/dependabot/pull_request_creator.rb', line 20

def branch_name_separator
  @branch_name_separator
end

#commit_message_options ⇒ Object (readonly)

Returns the value of attribute commit_message_options



20
21
22
 
# File 'lib/dependabot/pull_request_creator.rb', line 20

def commit_message_options
  @commit_message_options
end

#credentials ⇒ Object (readonly)

Returns the value of attribute credentials



20
21
22
 
# File 'lib/dependabot/pull_request_creator.rb', line 20

def credentials
  @credentials
end

#custom_headers ⇒ Object (readonly)

Returns the value of attribute custom_headers



20
21
22
 
# File 'lib/dependabot/pull_request_creator.rb', line 20

def custom_headers
  @custom_headers
end

#custom_labels ⇒ Object (readonly)

Returns the value of attribute custom_labels



20
21
22
 
# File 'lib/dependabot/pull_request_creator.rb', line 20

def custom_labels
  @custom_labels
end

#dependencies ⇒ Object (readonly)

Returns the value of attribute dependencies



20
21
22
 
# File 'lib/dependabot/pull_request_creator.rb', line 20

def dependencies
  @dependencies
end

#files ⇒ Object (readonly)

Returns the value of attribute files



20
21
22
 
# File 'lib/dependabot/pull_request_creator.rb', line 20

def files
  @files
end

#github_redirection_service ⇒ Object (readonly)

Returns the value of attribute github_redirection_service



20
21
22
 
# File 'lib/dependabot/pull_request_creator.rb', line 20

def github_redirection_service
  @github_redirection_service
end

#milestone ⇒ Object (readonly)

Returns the value of attribute milestone



20
21
22
 
# File 'lib/dependabot/pull_request_creator.rb', line 20

def milestone
  @milestone
end

#pr_message_footer ⇒ Object (readonly)

Returns the value of attribute pr_message_footer



20
21
22
 
# File 'lib/dependabot/pull_request_creator.rb', line 20

def pr_message_footer
  @pr_message_footer
end

#reviewers ⇒ Object (readonly)

Returns the value of attribute reviewers



20
21
22
 
# File 'lib/dependabot/pull_request_creator.rb', line 20

def reviewers
  @reviewers
end

#signature_key ⇒ Object (readonly)

Returns the value of attribute signature_key



20
21
22
 
# File 'lib/dependabot/pull_request_creator.rb', line 20

def signature_key
  @signature_key
end

#source ⇒ Object (readonly)

Returns the value of attribute source



20
21
22
 
# File 'lib/dependabot/pull_request_creator.rb', line 20

def source
  @source
end

#vulnerabilities_fixed ⇒ Object (readonly)

Returns the value of attribute vulnerabilities_fixed



20
21
22
 
# File 'lib/dependabot/pull_request_creator.rb', line 20

def vulnerabilities_fixed
  @vulnerabilities_fixed
end

Instance Method Details

#check_dependencies_have_previous_version ⇒ Object 



62
63
64
65
66
67
68
 
# File 'lib/dependabot/pull_request_creator.rb', line 62

def check_dependencies_have_previous_version
  return if library? && dependencies.all? { |d| requirements_changed?(d) }
  return if dependencies.all?(&:previous_version)

  raise "Dependencies must have a previous version or changed " \
        "requirement to have a pull request created for them!"
end

#create ⇒ Object 



70
71
72
73
74
75
76
77
78
 
# File 'lib/dependabot/pull_request_creator.rb', line 70

def create
  case source.provider
  when "github" then github_creator.create
  when "gitlab" then gitlab_creator.create
  when "azure" then azure_creator.create
  when "codecommit" then codecommit_creator.create
  else raise "Unsupported provider #{source.provider}"
  end
end