Class: Fastlane::Actions::BadgeAction

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

Constant Summary

Constants inherited from Fastlane::Action

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

Documentation collapse

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


146
147
148
# File 'fastlane/lib/fastlane/actions/badge.rb', line 146

def self.authors
  ["DanielGri"]
end

.available_optionsObject


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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
# File 'fastlane/lib/fastlane/actions/badge.rb', line 62

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|
                                   UI.user_error!("dark is only a flag and should always be true") 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|
                                   UI.user_error!("custom should be a valid file path") unless value && 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|
                                   UI.user_error!("no_badge is only a flag and should always be true") unless value == true
                                 end),
    FastlaneCore::ConfigItem.new(key: :shield,
                                 env_name: "FL_BADGE_SHIELD",
                                 description: "Add a shield to your app icon from shields.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|
                                   UI.user_error!("alpha is only a flag and should always be true") 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|
                                   UI.user_error!("path needs to be a valid directory") 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 shields.io request in seconds",
                                 optional: true,
                                 is_string: false,
                                 verify_block: proc do |value|
                                   UI.user_error!("shield_io_timeout needs to be an integer > 0") 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),
    FastlaneCore::ConfigItem.new(key: :alpha_channel,
                                 env_name: "FL_BADGE_ALPHA_CHANNEL",
                                 description: "Keeps/adds an alpha channel to the icon (useful for android icons)",
                                 optional: true,
                                 is_string: false,
                                 verify_block: proc do |value|
                                   UI.user_error!("alpha_channel is only a flag and should always be true") unless value == true
                                 end),
    FastlaneCore::ConfigItem.new(key: :shield_gravity,
                                 env_name: "FL_BADGE_SHIELD_GRAVITY",
                                 description: "Position of shield on icon. Default: North - Choices include: NorthWest, North, NorthEast, West, Center, East, SouthWest, South, SouthEast",
                                 optional: true,
                                 is_string: true),
    FastlaneCore::ConfigItem.new(key: :shield_no_resize,
                                 env_name: "FL_BADGE_SHIELD_NO_RESIZE",
                                 description: "Shield image will no longer be resized to aspect fill the full icon. Instead it will only be shrunk to not exceed the icon graphic",
                                 optional: true,
                                 is_string: false,
                                 verify_block: proc do |value|
                                   UI.user_error!("shield_no_resize is only a flag and should always be true") unless value == true
                                 end)
  ]
end

.categoryObject


58
59
60
# File 'fastlane/lib/fastlane/actions/badge.rb', line 58

def self.category
  :deprecated
end

.descriptionObject


35
36
37
# File 'fastlane/lib/fastlane/actions/badge.rb', line 35

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

.detailsObject


39
40
41
42
43
44
45
46
47
# File 'fastlane/lib/fastlane/actions/badge.rb', line 39

def self.details
  [
    "Please use the [badge plugin](https://github.com/HazAT/fastlane-plugin-badge) instead.",
    "This action will add a light/dark badge onto your app icon.",
    "You can also provide your custom badge/overlay or add a shield for more customization.",
    "More info: [https://github.com/HazAT/badge](https://github.com/HazAT/badge)",
    "**Note**: If you want to reset the badge back to default, you can use `sh 'git checkout -- <path>/Assets.xcassets/'`."
  ].join("\n")
end

.example_codeObject


49
50
51
52
53
54
55
56
# File 'fastlane/lib/fastlane/actions/badge.rb', line 49

def self.example_code
  [
    'badge(dark: true)',
    'badge(alpha: true)',
    'badge(custom: "/Users/xxx/Desktop/badge.png")',
    'badge(shield: "Version-0.0.3-blue", no_badge: true)'
  ]
end

.is_supported?(platform) ⇒ Boolean

Returns:


150
151
152
# File 'fastlane/lib/fastlane/actions/badge.rb', line 150

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
18
19
20
21
22
23
24
25
26
27
28
29
# File 'fastlane/lib/fastlane/actions/badge.rb', line 4

def self.run(params)
  UI.important('The badge action has been deprecated,')
  UI.important('please checkout the badge plugin here:')
  UI.important('https://github.com/HazAT/fastlane-plugin-badge')
  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],
    alpha_channel: params[:alpha_channel],
    shield_gravity: params[:shield_gravity],
    shield_no_resize: params[:shield_no_resize]
  }
  begin
    Badge::Runner.new.run(params[:path], options)
  rescue => e
    # We want to catch this error and raise our own so that we are not counting this as a crash in our metrics
    UI.verbose(e.backtrace.join("\n"))
    UI.user_error!("Something went wrong while running badge: #{e}")
  end
end