Class: Fastlane::Actions::SlackAction

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

Class Method Summary collapse

Methods inherited from Fastlane::Action

details, output, sh

Class Method Details

.author ⇒ Object 



140
141
142
 
# File 'lib/fastlane/actions/slack.rb', line 140

def self.author
  "KrauseFx"
end

.available_options ⇒ Object 



130
131
132
133
134
135
136
137
138
 
# File 'lib/fastlane/actions/slack.rb', line 130

def self.available_options
  [
    ['message', 'The message that should be displayed on Slack. This supports the standard Slack markup language'],
    ['channel', '#channel or @username'],
    ['success', 'Success or error?'],
    ['payload', 'Add additional information to this post. payload must be a hash containg any key with any value'],
    ['default_payloads', 'Remove some of the default payloads. More information about the available payloads GitHub']
  ]
end

.description ⇒ Object 



126
127
128
 
# File 'lib/fastlane/actions/slack.rb', line 126

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

.git_author ⇒ Object 



4
5
6
7
8
9
10
11
 
# File 'lib/fastlane/actions/slack.rb', line 4

def self.git_author
  s = `git log --name-status HEAD^..HEAD`
  s = s.match(/Author:.*<(.*)>/)[1]
  return s if s.to_s.length > 0
  return nil
rescue
  return nil
end

.last_git_commit ⇒ Object 



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

def self.last_git_commit
  s = `git log -1 --pretty=%B`.strip
  return s if s.to_s.length > 0
  nil
end

.run(params) ⇒ Object 



19
20
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
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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/fastlane/actions/slack.rb', line 19

def self.run(params)
  options = { message: '',
              success: true,
              channel: nil,
              payload: {}
            }.merge(params.first || {})

  require 'slack-notifier'

  color = (options[:success] ? 'good' : 'danger')
  options[:message] = options[:message].to_s

  options[:message] = Slack::Notifier::LinkFormatter.format(options[: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 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

  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,
    fields: []
  }

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

  # lane
  if should_add_payload[:lane]
    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: 'Test 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 git_author && 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: git_author,
        short: true
      }
    end
  end

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

  result = notifier.ping '',
                         icon_url: 'https://s3-eu-west-1.amazonaws.com/fastlane.tools/fastlane.png',
                         attachments: [slack_attachment]

  unless result.code.to_i == 200
    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
  else
    Helper.log.info 'Successfully sent Slack notification'.green
  end
end