Class: Fastlane::Actions::SlackAction

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

Constant Summary

Constants inherited from Fastlane::Action

Fastlane::Action::AVAILABLE_CATEGORIES

Helper collapse

Class Method Summary collapse

Methods inherited from Fastlane::Action

action_name, authors, lane_context, method_missing, other_action, output, return_value, sample_return_value, sh, step_text

Class Method Details

.author ⇒ Object 



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

def self.author
  "KrauseFx"
end

.available_options ⇒ Object 



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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/fastlane/actions/slack.rb', line 57

def self.available_options
  [
    FastlaneCore::ConfigItem.new(key: :message,
                                 env_name: "FL_SLACK_MESSAGE",
                                 description: "The message that should be displayed on Slack. This supports the standard Slack markup language",
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :channel,
                                 env_name: "FL_SLACK_CHANNEL",
                                 description: "#channel or @username",
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :use_webhook_configured_username_and_icon,
                                 env_name: "FL_SLACK_USE_WEBHOOK_CONFIGURED_USERNAME_AND_ICON",
                                 description: "Use webook's default username and icon settings? (true/false)",
                                 default_value: false,
                                 is_string: false,
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :slack_url,
                                 env_name: "SLACK_URL",
                                 description: "Create an Incoming WebHook for your Slack group",
                                 verify_block: proc do |value|
                                   UI.user_error!("Invalid URL, must start with https://") unless value.start_with? "https://"
                                 end),
    FastlaneCore::ConfigItem.new(key: :username,
                                 env_name: "FL_SLACK_USERNAME",
                                 description: "Overrides the webook's username property if use_webhook_configured_username_and_icon is false",
                                 default_value: "fastlane",
                                 is_string: true,
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :icon_url,
                                 env_name: "FL_SLACK_ICON_URL",
                                 description: "Overrides the webook's image property if use_webhook_configured_username_and_icon is false",
                                 default_value: "https://s3-eu-west-1.amazonaws.com/fastlane.tools/fastlane.png",
                                 is_string: true,
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :payload,
                                 env_name: "FL_SLACK_PAYLOAD",
                                 description: "Add additional information to this post. payload must be a hash containg any key with any value",
                                 default_value: {},
                                 is_string: false),
    FastlaneCore::ConfigItem.new(key: :default_payloads,
                                 env_name: "FL_SLACK_DEFAULT_PAYLOADS",
                                 description: "Remove some of the default payloads. More information about the available payloads on GitHub",
                                 optional: true,
                                 is_string: false),
    FastlaneCore::ConfigItem.new(key: :attachment_properties,
                                 env_name: "FL_SLACK_ATTACHMENT_PROPERTIES",
                                 description: "Merge additional properties in the slack attachment, see https://api.slack.com/docs/attachments",
                                 default_value: {},
                                 is_string: false),
    FastlaneCore::ConfigItem.new(key: :success,
                                 env_name: "FL_SLACK_SUCCESS",
                                 description: "Was this build successful? (true/false)",
                                 optional: true,
                                 default_value: true,
                                 is_string: false)
  ]
end

.category ⇒ Object 



145
146
147
 
# File 'lib/fastlane/actions/slack.rb', line 145

def self.category
  :notifications
end

.deep_merge(a, b) ⇒ Object

Adapted from stackoverflow.com/a/30225093/158525



233
234
235
236
237
238
239
240
 
# File 'lib/fastlane/actions/slack.rb', line 233

def self.deep_merge(a, b)
  merger = proc do |key, v1, v2|
    Hash === v1 && Hash === v2 ?
           v1.merge(v2, &merger) : Array === v1 && Array === v2 ?
             v1 | v2 : [:undefined, nil, :nil].include?(v2) ? v1 : v2
  end
  a.merge(b, &merger)
end

.description ⇒ Object 



53
54
55
 
# File 'lib/fastlane/actions/slack.rb', line 53

def self.description
  "Send a success/error message to your Slack group"
end

.details ⇒ Object 



149
150
151
 
# File 'lib/fastlane/actions/slack.rb', line 149

def self.details
  "Create an Incoming WebHook and export this as `SLACK_URL`. Can send a message to **#channel** (by default), a direct message to **@username** or a message to a private group **group** with success (green) or failure (red) status."
end

.example_code ⇒ Object 



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/fastlane/actions/slack.rb', line 119

def self.example_code
  [
    'slack(message: "App successfully released!")',
    'slack(
      message: "App successfully released!",
      channel: "#channel",  # Optional, by default will post to the default channel configured for the POST URL.
      success: true,        # Optional, defaults to true.
      payload: {            # Optional, lets you specify any number of your own Slack attachments.
        "Build Date" => Time.new.to_s,
        "Built by" => "Jenkins",
      },
      default_payloads: [:git_branch, :git_author], # Optional, lets you specify a whitelist of default payloads to include. Pass an empty array to suppress all the default payloads.
                                                    # Don\'t add this key, or pass nil, if you want all the default payloads. The available default payloads are: `lane`, `test_result`, `git_branch`, `git_author`, `last_git_commit_message`.
      attachment_properties: { # Optional, lets you specify any other properties available for attachments in the slack API (see https://api.slack.com/docs/attachments).
                               # This hash is deep merged with the existing properties set using the other properties above. This allows your own fields properties to be appended to the existing fields that were created using the `payload` property for instance.
        thumb_url: "http://example.com/path/to/thumb.png",
        fields: [{
          title: "My Field",
          value: "My Value",
          short: true
        }]
      }
    )'
  ]
end

.generate_slack_attachments(options) ⇒ Object 



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/fastlane/actions/slack.rb', line 157

def self.generate_slack_attachments(options)
  color = (options[:success] ? 'good' : 'danger')
  should_add_payload = ->(payload_name) { options[:default_payloads].nil? || options[:default_payloads].include?(payload_name) }

  slack_attachment = {
    fallback: options[:message],
    text: options[:message],
    color: color,
    mrkdwn_in: ["pretext", "text", "fields", "message"],
    fields: []
  }

  # custom user payloads
  slack_attachment[:fields] += options[:payload].map do |k, v|
    {
      title: k.to_s,
      value: Slack::Notifier::LinkFormatter.format(v.to_s),
      short: false
    }
  end

  # Add the lane to the Slack message
  # This might be nil, if slack is called as "one-off" action
  if should_add_payload[:lane] && Actions.lane_context[Actions::SharedValues::LANE_NAME]
    slack_attachment[:fields] << {
      title: 'Lane',
      value: Actions.lane_context[Actions::SharedValues::LANE_NAME],
      short: true
    }
  end

  # test_result
  if should_add_payload[:test_result]
    slack_attachment[:fields] << {
      title: 'Result',
      value: (options[:success] ? 'Success' : 'Error'),
      short: true
    }
  end

  # git branch
  if Actions.git_branch && should_add_payload[:git_branch]
    slack_attachment[:fields] << {
      title: 'Git Branch',
      value: Actions.git_branch,
      short: true
    }
  end

  # git_author
  if Actions.git_author_email && should_add_payload[:git_author]
    if ENV['FASTLANE_SLACK_HIDE_AUTHOR_ON_SUCCESS'] && options[:success]
      # We only show the git author if the build failed
    else
      slack_attachment[:fields] << {
        title: 'Git Author',
        value: Actions.git_author_email,
        short: true
      }
    end
  end

  # last_git_commit
  if Actions.last_git_commit_message && should_add_payload[:last_git_commit]
    slack_attachment[:fields] << {
      title: 'Git Commit',
      value: Actions.last_git_commit_message,
      short: false
    }
  end

  # merge additional properties
  deep_merge(slack_attachment, options[:attachment_properties])
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean) 


7
8
9
 
# File 'lib/fastlane/actions/slack.rb', line 7

def self.is_supported?(platform)
  true
end

.run(options) ⇒ Object 



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/fastlane/actions/slack.rb', line 21

def self.run(options)
  require 'slack-notifier'

  options[:message] = self.trim_message(options[:message].to_s || '')
  options[:message] = Slack::Notifier::LinkFormatter.format(options[:message])

  notifier = Slack::Notifier.new(options[:slack_url])

  notifier.username = options[:use_webhook_configured_username_and_icon] ? nil : options[:username]
  icon_url = options[:use_webhook_configured_username_and_icon] ? nil : options[:icon_url]

  if options[:channel].to_s.length > 0
    notifier.channel = options[:channel]
    notifier.channel = ('#' + notifier.channel) unless ['#', '@'].include?(notifier.channel[0]) # send message to channel by default
  end

  slack_attachment = generate_slack_attachments(options)

  return [notifier, slack_attachment] if Helper.is_test? # tests will verify the slack attachments and other properties

  result = notifier.ping '',
                         icon_url: icon_url,
                         attachments: [slack_attachment]

  if result.code.to_i == 200
    UI.success('Successfully sent Slack notification')
  else
    UI.verbose(result)
    UI.user_error!("Error pushing Slack message, maybe the integration has no permission to post on this channel? Try removing the channel parameter in your Fastfile.")
  end
end

.trim_message(message) ⇒ Object

As there is a text limit in the notifications, we are usually interested in the last part of the message e.g. for tests



14
15
16
17
18
19
 
# File 'lib/fastlane/actions/slack.rb', line 14

def self.trim_message(message)
  # We want the last 7000 characters, instead of the first 7000, as the error is at the bottom
  start_index = [message.length - 7000, 0].max
  message = message[start_index..-1]
  message
end