Class: Fastlane::Actions::SpmAction

Inherits:
Fastlane::Action show all
Defined in:
fastlane/lib/fastlane/actions/spm.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, details, 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

.authors ⇒ Object 



59
60
61
 
# File 'fastlane/lib/fastlane/actions/spm.rb', line 59

def self.authors
  ["Flávio Caetano (@fjcaetano)"]
end

.available_commands ⇒ Object 



82
83
84
 
# File 'fastlane/lib/fastlane/actions/spm.rb', line 82

def self.available_commands
  %w(build test) + self.package_commands
end

.available_options ⇒ Object 



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

def self.available_options
  [
    FastlaneCore::ConfigItem.new(key: :command,
                                 env_name: "FL_SPM_COMMAND",
                                 description: "The swift command (one of: #{available_commands.join(', ')})",
                                 default_value: "build",
                                 verify_block: proc do |value|
                                   UI.user_error!("Please pass a valid command. Use one of the following: #{available_commands.join(', ')}") unless available_commands.include?(value)
                                 end),
    FastlaneCore::ConfigItem.new(key: :build_path,
                                 env_name: "FL_SPM_BUILD_PATH",
                                 description: "Specify build/cache directory [default: ./.build]",
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :package_path,
                                 env_name: "FL_SPM_PACKAGE_PATH",
                                 description: "Change working directory before any other operation",
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :configuration,
                                 short_option: "-c",
                                 env_name: "FL_SPM_CONFIGURATION",
                                 description: "Build with configuration (debug|release) [default: debug]",
                                 optional: true,
                                 verify_block: proc do |value|
                                   UI.user_error!("Please pass a valid configuration: (debug|release)") unless valid_configurations.include?(value)
                                 end),
    FastlaneCore::ConfigItem.new(key: :verbose,
                                 short_option: "-v",
                                 env_name: "FL_SPM_VERBOSE",
                                 description: "Increase verbosity of informational output",
                                 is_string: false,
                                 default_value: false)
  ]
end

.category ⇒ Object 



78
79
80
 
# File 'fastlane/lib/fastlane/actions/spm.rb', line 78

def self.category
  :building
end

.description ⇒ Object 



21
22
23
 
# File 'fastlane/lib/fastlane/actions/spm.rb', line 21

def self.description
  "Runs Swift Package Manager on your project"
end

.example_code ⇒ Object 



67
68
69
70
71
72
73
74
75
76
 
# File 'fastlane/lib/fastlane/actions/spm.rb', line 67

def self.example_code
  [
    'spm',
    'spm(
      command: "build",
      build_path: "./build",
      configuration: "release"
    )'
  ]
end

.is_supported?(platform) ⇒ Boolean

Returns:



63
64
65
 
# File 'fastlane/lib/fastlane/actions/spm.rb', line 63

def self.is_supported?(platform)
  true
end

.package_commands ⇒ Object 



86
87
88
 
# File 'fastlane/lib/fastlane/actions/spm.rb', line 86

def self.package_commands
  %w(clean reset update)
end

.run(params) ⇒ Object 



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

def self.run(params)
  cmd = ["swift"]

  cmd << (package_commands.include?(params[:command]) ? "package" : params[:command])
  cmd << "--build-path #{params[:build_path]}" if params[:build_path]
  cmd << "--package-path #{params[:package_path]}" if params[:package_path]
  cmd << "--configuration #{params[:configuration]}" if params[:configuration]
  cmd << "--verbose" if params[:verbose]
  cmd << params[:command] if package_commands.include?(params[:command])

  sh(cmd.join(" "))
end

.valid_configurations ⇒ Object 



90
91
92
 
# File 'fastlane/lib/fastlane/actions/spm.rb', line 90

def self.valid_configurations
  %w(debug release)
end