Class: Fastlane::Actions::SlackAction
- Inherits:
-
Fastlane::Action
- Object
- Fastlane::Action
- Fastlane::Actions::SlackAction
- Defined in:
- lib/fastlane/actions/slack.rb
Helper collapse
-
.deep_merge(a, b) ⇒ Object
Adapted from stackoverflow.com/a/30225093/158525.
- .generate_slack_attachments(options) ⇒ Object
Class Method Summary collapse
- .author ⇒ Object
- .available_options ⇒ Object
- .description ⇒ Object
- .is_supported?(platform) ⇒ Boolean
- .run(options) ⇒ Object
-
.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.
Methods inherited from Fastlane::Action
action_name, authors, details, output, return_value, sh, step_text
Class Method Details
.author ⇒ Object
102 103 104 |
# File 'lib/fastlane/actions/slack.rb', line 102 def self. "KrauseFx" end |
.available_options ⇒ Object
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 |
# File 'lib/fastlane/actions/slack.rb', line 62 def self. [ 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: :slack_url, env_name: "SLACK_URL", description: "Create an Incoming WebHook for your Slack group", verify_block: proc do |value| raise "Invalid URL, must start with https://" unless value.start_with? "https://" end), 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 |
.deep_merge(a, b) ⇒ Object
Adapted from stackoverflow.com/a/30225093/158525
185 186 187 188 189 190 191 192 |
# File 'lib/fastlane/actions/slack.rb', line 185 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
58 59 60 |
# File 'lib/fastlane/actions/slack.rb', line 58 def self.description "Send a success/error message to your Slack group" end |
.generate_slack_attachments(options) ⇒ Object
110 111 112 113 114 115 116 117 118 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 144 145 146 147 148 149 150 151 152 153 154 155 156 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 |
# File 'lib/fastlane/actions/slack.rb', line 110 def self.() color = ([:success] ? 'good' : 'danger') should_add_payload = ->(payload_name) { [:default_payloads].nil? || [:default_payloads].include?(payload_name) } = { fallback: [:message], text: [:message], color: color, mrkdwn_in: ["pretext", "text", "fields", "message"], fields: [] } # custom user payloads [:fields] += [:payload].map do |k, v| { title: k.to_s, value: Slack::Notifier::LinkFormatter.format(v.to_s), short: false } end # lane if should_add_payload[:lane] [:fields] << { title: 'Lane', value: Actions.lane_context[Actions::SharedValues::LANE_NAME], short: true } end # test_result if should_add_payload[:test_result] [:fields] << { title: 'Result', value: ([:success] ? 'Success' : 'Error'), short: true } end # git branch if Actions.git_branch && should_add_payload[:git_branch] [:fields] << { title: 'Git Branch', value: Actions.git_branch, short: true } end # git_author if Actions. && should_add_payload[:git_author] if ENV['FASTLANE_SLACK_HIDE_AUTHOR_ON_SUCCESS'] && [:success] # We only show the git author if the build failed else [:fields] << { title: 'Git Author', value: Actions., short: true } end end # last_git_commit if Actions.last_git_commit && should_add_payload[:last_git_commit] [:fields] << { title: 'Git Commit', value: Actions.last_git_commit, short: false } end # merge additional properties deep_merge(, [:attachment_properties]) end |
.is_supported?(platform) ⇒ Boolean
8 9 10 |
# File 'lib/fastlane/actions/slack.rb', line 8 def self.is_supported?(platform) true end |
.run(options) ⇒ Object
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 52 53 54 55 56 |
# File 'lib/fastlane/actions/slack.rb', line 22 def self.run() require 'slack-notifier' [:message] = self.([:message].to_s || '') [:message] = Slack::Notifier::LinkFormatter.format([:message]) url = ENV['SLACK_URL'] unless url Helper.log.fatal "Please add 'ENV[\"SLACK_URL\"] = \"https://hooks.slack.com/services/...\"' to your Fastfile's `before_all` section.".red raise 'No SLACK_URL given.'.red end notifier = Slack::Notifier.new(url) notifier.username = 'fastlane' if [:channel].to_s.length > 0 notifier.channel = [:channel] notifier.channel = ('#' + notifier.channel) unless ['#', '@'].include?(notifier.channel[0]) # send message to channel by default end = () return [notifier, ] if Helper.is_test? # tests will verify the slack attachments and other properties result = notifier.ping '', icon_url: 'https://s3-eu-west-1.amazonaws.com/fastlane.tools/fastlane.png', attachments: [] if result.code.to_i == 200 Helper.log.info 'Successfully sent Slack notification'.green else Helper.log.debug result raise 'Error pushing Slack message, maybe the integration has no permission to post on this channel? Try removing the channel parameter in your Fastfile.'.red 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
15 16 17 18 19 20 |
# File 'lib/fastlane/actions/slack.rb', line 15 def self.() # We want the last 7000 characters, instead of the first 7000, as the error is at the bottom start_index = [.length - 7000, 0].max = [start_index..-1] end |