Class: Fastlane::Actions::BadgeAction

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

Documentation collapse

Class Method Summary collapse

Methods inherited from Fastlane::Action

action_name, author, output, return_value, sh, step_text

Class Method Details

.authorsObject



98
99
100
# File 'lib/fastlane/actions/badge.rb', line 98

def self.authors
  ["DanielGri"]
end

.available_optionsObject



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
# File 'lib/fastlane/actions/badge.rb', line 35

def self.available_options
  [
    FastlaneCore::ConfigItem.new(key: :dark,
                                 env_name: "FL_BADGE_DARK",
                                 description: "Adds a dark flavored badge ontop of your icon",
                                 optional: true,
                                 is_string: false,
                                 verify_block: proc do |value|
                                   raise "dark is only a flag and should always be true".red unless value == true
                                 end),
    FastlaneCore::ConfigItem.new(key: :custom,
                                 env_name: "FL_BADGE_CUSTOM",
                                 description: "Add your custom overlay/badge image",
                                 optional: true,
                                 verify_block: proc do |value|
                                   raise "custom should be a valid file path".red unless value and File.exist?(value)
                                 end),
    FastlaneCore::ConfigItem.new(key: :no_badge,
                                 env_name: "FL_BADGE_NO_BADGE",
                                 description: "Hides the beta badge",
                                 optional: true,
                                 is_string: false,
                                 verify_block: proc do |value|
                                   raise "no_badge is only a flag and should always be true".red unless value == true
                                 end),
    FastlaneCore::ConfigItem.new(key: :shield,
                                 env_name: "FL_BADGE_SHIELD",
                                 description: "Add a shield to your app icon from shield.io",
                                 optional: true,
                                 is_string: true),
    FastlaneCore::ConfigItem.new(key: :alpha,
                                 env_name: "FL_BADGE_ALPHA",
                                 description: "Adds and alpha badge instead of the default beta one",
                                 optional: true,
                                 is_string: false,
                                 verify_block: proc do |value|
                                   raise "alpha is only a flag and should always be true".red unless value == true
                                 end),
    FastlaneCore::ConfigItem.new(key: :path,
                                 env_name: "FL_BADGE_PATH",
                                 description: "Sets the root path to look for AppIcons",
                                 optional: true,
                                 is_string: true,
                                 default_value: '.',
                                 verify_block: proc do |value|
                                   raise "path needs to be a valid directory".red if Dir[value].empty?
                                 end),
    FastlaneCore::ConfigItem.new(key: :shield_io_timeout,
                                 env_name: "FL_BADGE_SHIELD_IO_TIMEOUT",
                                 description: "Set custom duration for the timeout of the shield.io request in seconds",
                                 optional: true,
                                 is_string: false,
                                 verify_block: proc do |value|
                                   raise "shield_io_timeout needs to be an integer > 0".red if value.to_i < 1
                                 end),
    FastlaneCore::ConfigItem.new(key: :glob,
                                 env_name: "FL_BADGE_GLOB",
                                 description: "Glob pattern for finding image files",
                                 optional: true,
                                 is_string: true)
  ]
end

.descriptionObject



23
24
25
# File 'lib/fastlane/actions/badge.rb', line 23

def self.description
  "Automatically add a badge to your iOS app icon"
end

.detailsObject



27
28
29
30
31
32
33
# File 'lib/fastlane/actions/badge.rb', line 27

def self.details
  [
    "This action will add a light/dark badge onto your app icon.",
    "You can also provide your custom badge/overlay or add an shield for more customization more info:",
    "https://github.com/HazAT/badge"
  ].join("\n")
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean)


102
103
104
# File 'lib/fastlane/actions/badge.rb', line 102

def self.is_supported?(platform)
  [:ios, :mac, :android].include?(platform)
end

.run(params) ⇒ Object



4
5
6
7
8
9
10
11
12
13
14
15
16
17
# File 'lib/fastlane/actions/badge.rb', line 4

def self.run(params)
  Actions.verify_gem!('badge')
  require 'badge'
  options = {
    dark: params[:dark],
    custom: params[:custom],
    no_badge: params[:no_badge],
    shield: params[:shield],
    alpha: params[:alpha],
    shield_io_timeout: params[:shield_io_timeout],
    glob: params[:glob]
  }
  Badge::Runner.new.run(params[:path], options)
end