Class: Fastlane::Action

Inherits:
Object
  • Object
show all
Defined in:
lib/fastlane/action.rb

Direct Known Subclasses

Fastlane::Actions::AddGitTagAction, Fastlane::Actions::AppstoreAction, Fastlane::Actions::BackupFileAction, Fastlane::Actions::BackupXcarchiveAction, Fastlane::Actions::CarthageAction, Fastlane::Actions::CertAction, Fastlane::Actions::ChatworkAction, Fastlane::Actions::CleanBuildArtifactsAction, Fastlane::Actions::CocoapodsAction, Fastlane::Actions::CommitVersionBumpAction, Fastlane::Actions::CrashlyticsAction, Fastlane::Actions::CreateKeychainAction, Fastlane::Actions::DefaultPlatformAction, Fastlane::Actions::DeleteKeychainAction, Fastlane::Actions::DeliverAction, Fastlane::Actions::DeploygateAction, Fastlane::Actions::DsymZipAction, Fastlane::Actions::EnsureGitBranchAction, Fastlane::Actions::EnsureGitStatusCleanAction, Fastlane::Actions::FastlaneVersionAction, Fastlane::Actions::FrameitAction, Fastlane::Actions::GcovrAction, Fastlane::Actions::GetGithubReleaseAction, Fastlane::Actions::GitBranchAction, Fastlane::Actions::HgAddTagAction, Fastlane::Actions::HgCommitVersionBumpAction, Fastlane::Actions::HgEnsureCleanStatusAction, Fastlane::Actions::HgPushAction, Fastlane::Actions::HipchatAction, Fastlane::Actions::HockeyAction, Fastlane::Actions::ImportCertificateAction, Fastlane::Actions::IncrementBuildNumberAction, Fastlane::Actions::IncrementVersionNumberAction, Fastlane::Actions::IpaAction, Fastlane::Actions::LaneContextAction, Fastlane::Actions::LcovAction, Fastlane::Actions::MailgunAction, Fastlane::Actions::NotifyAction, Fastlane::Actions::OclintAction, Fastlane::Actions::OptOutUsageAction, Fastlane::Actions::PemAction, Fastlane::Actions::ProduceAction, Fastlane::Actions::PromptAction, Fastlane::Actions::PushToGitRemoteAction, Fastlane::Actions::PutsAction, Fastlane::Actions::RegisterDevicesAction, Fastlane::Actions::ResetGitRepoAction, Fastlane::Actions::ResignAction, Fastlane::Actions::RestoreFileAction, Fastlane::Actions::S3Action, Fastlane::Actions::SayAction, Fastlane::Actions::SetBuildNumberRepositoryAction, Fastlane::Actions::SighAction, Fastlane::Actions::SlackAction, Fastlane::Actions::SnapshotAction, Fastlane::Actions::TeamIdAction, Fastlane::Actions::TeamNameAction, Fastlane::Actions::TestflightAction, Fastlane::Actions::TestmunkAction, Fastlane::Actions::TypetalkAction, Fastlane::Actions::UpdateAppGroupIdentifiersAction, Fastlane::Actions::UpdateFastlaneAction, Fastlane::Actions::UpdateInfoPlistAction, Fastlane::Actions::UpdateProjectCodeSigningAction, Fastlane::Actions::UpdateProjectProvisioningAction, Fastlane::Actions::XcarchiveAction, Fastlane::Actions::XcbuildAction, Fastlane::Actions::XccleanAction, Fastlane::Actions::XcexportAction, Fastlane::Actions::XcodeSelectAction, Fastlane::Actions::XcodebuildAction, Fastlane::Actions::XctestAction, Fastlane::Actions::XctoolAction

Class Method Summary collapse

Class Method Details

.action_nameObject

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


67
68
69
# File 'lib/fastlane/action.rb', line 67

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

.authorObject


36
37
38
# File 'lib/fastlane/action.rb', line 36

def self.author
  nil
end

.authorsObject


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

def self.authors
  nil
end

.available_optionsObject


18
19
20
21
22
23
24
25
26
# File 'lib/fastlane/action.rb', line 18

def self.available_options
  # Return an array of 2-3 element arrays, like:
  # [
  #   ['app_identifier', 'This value is responsible for X', 'ENVIRONMENT_VARIABLE'],
  #   ['app_identifier', 'This value is responsible for X']
  # ]
  # Take a look at sigh.rb if you're using the config manager of fastlane
  nil
end

.descriptionObject

Implement in subclasses


10
11
12
# File 'lib/fastlane/action.rb', line 10

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

.detailsObject


14
15
16
# File 'lib/fastlane/action.rb', line 14

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

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean)

44
45
46
47
48
49
50
51
52
53
# File 'lib/fastlane/action.rb', line 44

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

.outputObject


28
29
30
31
32
33
34
# File 'lib/fastlane/action.rb', line 28

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

.run(params) ⇒ Object


5
6
7
# File 'lib/fastlane/action.rb', line 5

def self.run(params)
  
end

.sh(command) ⇒ Object

to allow a simple `sh` in the custom actions


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

def self.sh(command)
  Fastlane::Actions.sh(command)
end

.step_textObject

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


57
58
59
# File 'lib/fastlane/action.rb', line 57

def self.step_text
  self.action_name
end