Class: Fastlane::Actions::DangerAction

Inherits:
Fastlane::Action show all
Defined in:
fastlane/lib/fastlane/actions/danger.rb

Constant Summary

Constants inherited from Fastlane::Action

Fastlane::Action::AVAILABLE_CATEGORIES, Fastlane::Action::RETURN_TYPES

Class Method Summary collapse

Methods inherited from Fastlane::Action

action_name, author, deprecated_notes, lane_context, method_missing, other_action, output, return_type, return_value, sample_return_value, shell_out_should_use_bundle_exec?, step_text

Class Method Details

.authorsObject


119
120
121
# File 'fastlane/lib/fastlane/actions/danger.rb', line 119

def self.authors
  ["KrauseFx"]
end

.available_optionsObject


41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
# File 'fastlane/lib/fastlane/actions/danger.rb', line 41

def self.available_options
  [
    FastlaneCore::ConfigItem.new(key: :use_bundle_exec,
                                 env_name: "FL_DANGER_USE_BUNDLE_EXEC",
                                 description: "Use bundle exec when there is a Gemfile presented",
                                 is_string: false,
                                 default_value: true),
    FastlaneCore::ConfigItem.new(key: :verbose,
                                 env_name: "FL_DANGER_VERBOSE",
                                 description: "Show more debugging information",
                                 is_string: false,
                                 default_value: false),
    FastlaneCore::ConfigItem.new(key: :danger_id,
                                 env_name: "FL_DANGER_ID",
                                 description: "The identifier of this Danger instance",
                                 is_string: true,
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :dangerfile,
                                 env_name: "FL_DANGER_DANGERFILE",
                                 description: "The location of your Dangerfile",
                                 is_string: true,
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :github_api_token,
                                 env_name: "FL_DANGER_GITHUB_API_TOKEN",
                                 description: "GitHub API token for danger",
                                 sensitive: true,
                                 is_string: true,
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :fail_on_errors,
                                 env_name: "FL_DANGER_FAIL_ON_ERRORS",
                                 description: "Should always fail the build process, defaults to false",
                                 is_string: false,
                                 optional: true,
                                 default_value: false),
    FastlaneCore::ConfigItem.new(key: :new_comment,
                                 env_name: "FL_DANGER_NEW_COMMENT",
                                 description: "Makes Danger post a new comment instead of editing its previous one",
                                 is_string: false,
                                 optional: true,
                                 default_value: false),
    FastlaneCore::ConfigItem.new(key: :base,
                                 env_name: "FL_DANGER_BASE",
                                 description: "A branch/tag/commit to use as the base of the diff. [master|dev|stable]",
                                 is_string: true,
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :head,
                                 env_name: "FL_DANGER_HEAD",
                                 description: "A branch/tag/commit to use as the head. [master|dev|stable]",
                                 is_string: true,
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :pr,
                                 env_name: "FL_DANGER_PR",
                                 description: "Run danger on a specific pull request. e.g. \"https://github.com/danger/danger/pull/518\"",
                                 is_string: true,
                                 optional: true)
  ]
end

.categoryObject


115
116
117
# File 'fastlane/lib/fastlane/actions/danger.rb', line 115

def self.category
  :misc
end

.descriptionObject


30
31
32
# File 'fastlane/lib/fastlane/actions/danger.rb', line 30

def self.description
  "Runs `danger` for the project"
end

.detailsObject


34
35
36
37
38
39
# File 'fastlane/lib/fastlane/actions/danger.rb', line 34

def self.details
  [
    "Formalize your Pull Request etiquette.",
    "More information: [https://github.com/danger/danger](https://github.com/danger/danger)."
  ].join("\n")
end

.example_codeObject


103
104
105
106
107
108
109
110
111
112
113
# File 'fastlane/lib/fastlane/actions/danger.rb', line 103

def self.example_code
  [
    'danger',
    'danger(
      danger_id: "unit-tests",
      dangerfile: "tests/MyOtherDangerFile",
      github_api_token: ENV["GITHUB_API_TOKEN"],
      verbose: true
    )'
  ]
end

.is_supported?(platform) ⇒ Boolean

Returns:


99
100
101
# File 'fastlane/lib/fastlane/actions/danger.rb', line 99

def self.is_supported?(platform)
  true
end

.run(params) ⇒ Object


4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
# File 'fastlane/lib/fastlane/actions/danger.rb', line 4

def self.run(params)
  Actions.verify_gem!('danger')
  cmd = []

  cmd << 'bundle exec' if params[:use_bundle_exec] && shell_out_should_use_bundle_exec?
  cmd << 'danger'
  cmd << '--verbose' if params[:verbose]

  danger_id = params[:danger_id]
  dangerfile = params[:dangerfile]
  base = params[:base]
  head = params[:head]
  pr = params[:pr]
  cmd << "--danger_id=#{danger_id}" if danger_id
  cmd << "--dangerfile=#{dangerfile}" if dangerfile
  cmd << "--fail-on-errors=true" if params[:fail_on_errors]
  cmd << "--new-comment" if params[:new_comment]
  cmd << "--base=#{base}" if base
  cmd << "--head=#{head}" if head
  cmd << "pr #{pr}" if pr

  ENV['DANGER_GITHUB_API_TOKEN'] = params[:github_api_token] if params[:github_api_token]

  Actions.sh(cmd.join(' '))
end