Class: Fastlane::Action

Inherits:

Object

Object
Fastlane::Action

show all

Extended by:: Forwardable

Defined in:: fastlane/lib/fastlane/action.rb

Direct Known Subclasses

Constant Summary collapse

AVAILABLE_CATEGORIES =

[
  :testing,
  :building,
  :screenshots,
  :project,
  :code_signing,
  :documentation,
  :beta,
  :push,
  :production,
  :source_control,
  :notifications,
  :app_store_connect,
  :misc,
  :deprecated # This should be the last item
]

RETURN_TYPES =

[
  :string,
  :array_of_strings,
  :hash_of_strings,
  :hash,
  :bool,
  :int
]

Class Attribute Summary collapse

.runner ⇒ Object

Returns the value of attribute runner.

Class Method Summary collapse

.action_name ⇒ Object

instead of “AddGitAction”, this will return “add_git” to print it to the user.
.author ⇒ Object
.authors ⇒ Object
.available_options ⇒ Object
.category ⇒ Object

Documentation category, available values defined in AVAILABLE_CATEGORIES.
.deprecated_notes ⇒ Object

Describes how the user should handle deprecated an action if its deprecated Returns a string (or nil).
.description ⇒ Object

Implement in subclasses.
.details ⇒ Object
.example_code ⇒ Object

Returns an array of string of sample usage of this action.
.is_supported?(platform) ⇒ Boolean
.lane_context ⇒ Object
.method_missing(method_sym, *arguments, &_block) ⇒ Object

Allows the user to call an action from an action.
.other_action ⇒ Object

Return a new instance of the OtherAction action We need to do this, since it has to have access to the runner object.
.output ⇒ Object
.return_type ⇒ Object
.return_value ⇒ Object
.run(params) ⇒ Object
.sample_return_value ⇒ Object
.shell_out_should_use_bundle_exec? ⇒ Boolean

When shelling out from the action, should we use ‘bundle exec`?.
.step_text(params) ⇒ Object

Is printed out in the Steps: output in the terminal Return nil if you don’t want any logging in the terminal/JUnit Report.

Class Attribute Details

.runner ⇒ `Object`

Returns the value of attribute runner.



33
34
35

# File 'fastlane/lib/fastlane/action.rb', line 33

def runner
  @runner
end

Class Method Details

.action_name ⇒ `Object`

instead of “AddGitAction”, this will return “add_git” to print it to the user



123
124
125

# File 'fastlane/lib/fastlane/action.rb', line 123

def self.action_name
  self.name.split('::').last.gsub(/Action$/, '').fastlane_underscore
end

.author ⇒ `Object`



87
88
89

# File 'fastlane/lib/fastlane/action.rb', line 87

def self.author
  nil
end

.authors ⇒ `Object`



91
92
93

# File 'fastlane/lib/fastlane/action.rb', line 91

def self.authors
  nil
end

.available_options ⇒ `Object`

# File 'fastlane/lib/fastlane/action.rb', line 53

def self.available_options
  # [
  #   FastlaneCore::ConfigItem.new(key: :ipa_path,
  #                                env_name: "CRASHLYTICS_IPA_PATH",
  #                                description: "Value Description")
  # ]
  nil
end

.category ⇒ `Object`

Documentation category, available values defined in AVAILABLE_CATEGORIES



118
119
120

# File 'fastlane/lib/fastlane/action.rb', line 118

def self.category
  :undefined
end

.deprecated_notes ⇒ `Object`

Describes how the user should handle deprecated an action if its deprecated Returns a string (or nil)



151
152
153

# File 'fastlane/lib/fastlane/action.rb', line 151

def self.deprecated_notes
  nil
end

.description ⇒ `Object`

Implement in subclasses



45
46
47

# File 'fastlane/lib/fastlane/action.rb', line 45

def self.description
  "No description provided".red
end

.details ⇒ `Object`



49
50
51

# File 'fastlane/lib/fastlane/action.rb', line 49

def self.details
  nil # this is your chance to provide a more detailed description of this action
end

.example_code ⇒ `Object`

Returns an array of string of sample usage of this action



107
108
109

# File 'fastlane/lib/fastlane/action.rb', line 107

def self.example_code
  nil
end

.is_supported?(platform) ⇒ `Boolean`

Returns:

(Boolean)

# File 'fastlane/lib/fastlane/action.rb', line 95

def self.is_supported?(platform)
  # you can do things like
  #  true
  #
  #  platform == :ios
  #
  #  [:ios, :mac].include?(platform)
  #
  UI.crash!("Implementing `is_supported?` for all actions is mandatory. Please update #{self}")
end

.lane_context ⇒ `Object`



127
128
129

# File 'fastlane/lib/fastlane/action.rb', line 127

def self.lane_context
  Actions.lane_context
end

.method_missing(method_sym, *arguments, &_block) ⇒ `Object`

Allows the user to call an action from an action

# File 'fastlane/lib/fastlane/action.rb', line 132

def self.method_missing(method_sym, *arguments, &_block)
  UI.error("Unknown method '#{method_sym}'")
  UI.user_error!("To call another action from an action use `other_action.#{method_sym}` instead")
end

.other_action ⇒ `Object`

Return a new instance of the OtherAction action We need to do this, since it has to have access to the runner object



145
146
147

# File 'fastlane/lib/fastlane/action.rb', line 145

def self.other_action
  return OtherAction.new(self.runner)
end

.output ⇒ `Object`

# File 'fastlane/lib/fastlane/action.rb', line 62

def self.output
  # Return the keys you provide on the shared area
  # [
  #   ['IPA_OUTPUT_PATH', 'The path to the newly generated ipa file']
  # ]
  nil
end

.return_type ⇒ `Object`

# File 'fastlane/lib/fastlane/action.rb', line 70

def self.return_type
  # Describes what type of data is expected to be returned, see RETURN_TYPES
  nil
end

.return_value ⇒ `Object`

# File 'fastlane/lib/fastlane/action.rb', line 75

def self.return_value
  # Describes what this method returns
  nil
end

.run(params) ⇒ `Object`



41
42

# File 'fastlane/lib/fastlane/action.rb', line 41

def self.run(params)
end

.sample_return_value ⇒ `Object`

# File 'fastlane/lib/fastlane/action.rb', line 80

def self.sample_return_value
  # Very optional
  # You can return a sample return value, that might be returned by the actual action
  # This is currently only used when generating the documentation and running its tests
  nil
end

.shell_out_should_use_bundle_exec? ⇒ `Boolean`

When shelling out from the action, should we use ‘bundle exec`?

Returns:

(Boolean)



138
139
140

# File 'fastlane/lib/fastlane/action.rb', line 138

def self.shell_out_should_use_bundle_exec?
  return File.exist?('Gemfile') && !Helper.contained_fastlane?
end

.step_text(params) ⇒ `Object`

Is printed out in the Steps: output in the terminal Return nil if you don’t want any logging in the terminal/JUnit Report



113
114
115

# File 'fastlane/lib/fastlane/action.rb', line 113

def self.step_text(params)
  self.action_name
end

Class: Fastlane::Action

Direct Known Subclasses

Constant Summary collapse

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.runner ⇒ Object

Class Method Details

.action_name ⇒ Object

.author ⇒ Object

.authors ⇒ Object

.available_options ⇒ Object

.category ⇒ Object

.deprecated_notes ⇒ Object

.description ⇒ Object

.details ⇒ Object

.example_code ⇒ Object

.is_supported?(platform) ⇒ Boolean

.lane_context ⇒ Object

.method_missing(method_sym, *arguments, &_block) ⇒ Object

.other_action ⇒ Object

.output ⇒ Object

.return_type ⇒ Object

.return_value ⇒ Object

.run(params) ⇒ Object

.sample_return_value ⇒ Object

.shell_out_should_use_bundle_exec? ⇒ Boolean

.step_text(params) ⇒ Object