Class: Fastlane::Actions::ImportFromGitAction

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

.authors ⇒ Object 



52
53
54
 
# File 'fastlane/lib/fastlane/actions/import_from_git.rb', line 52

def self.authors
  ["fabiomassimo", "KrauseFx", "Liquidsoul"]
end

.available_options ⇒ Object 



20
21
22
23
24
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
 
# File 'fastlane/lib/fastlane/actions/import_from_git.rb', line 20

def self.available_options
  [
    # Because the `run` method is actually implemented in `fast_file.rb`,
    # and because magic, some of the parameters on `ConfigItem`s (e.g.
    # `conflicting_options`, `verify_block`) are completely ignored.
    FastlaneCore::ConfigItem.new(key: :url,
                                 description: "The URL of the repository to import the Fastfile from",
                                 default_value: nil),
    FastlaneCore::ConfigItem.new(key: :branch,
                                 description: "The branch or tag to check-out on the repository",
                                 default_value: 'HEAD',
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :dependencies,
                                description: "The array of additional Fastfiles in the repository",
                                default_value: [],
                                optional: true),
    FastlaneCore::ConfigItem.new(key: :path,
                                 description: "The path of the Fastfile in the repository",
                                 default_value: 'fastlane/Fastfile',
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :version,
                                 description: "The version to checkout on the repository. Optimistic match operator or multiple conditions can be used to select the latest version within constraints",
                                 default_value: nil,
                                 is_string: false,
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :cache_path,
                                 description: "The path to a directory where the repository should be cloned into. Defaults to `nil`, which causes the repository to be cloned on every call, to a temporary directory",
                                 default_value: nil,
                                 optional: true)
  ]
end

.category ⇒ Object 



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

def self.category
  :misc
end

.description ⇒ Object 



12
13
14
 
# File 'fastlane/lib/fastlane/actions/import_from_git.rb', line 12

def self.description
  "Import another Fastfile from a remote git repository to use its lanes"
end

.details ⇒ Object 



16
17
18
 
# File 'fastlane/lib/fastlane/actions/import_from_git.rb', line 16

def self.details
  "This is useful if you have shared lanes across multiple apps and you want to store the Fastfile in a remote git repository."
end

.example_code ⇒ Object 



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'fastlane/lib/fastlane/actions/import_from_git.rb', line 60

def self.example_code
  [
    'import_from_git(
      url: "[email protected]:fastlane/fastlane.git", # The URL of the repository to import the Fastfile from.
      branch: "HEAD", # The branch to checkout on the repository.
      path: "fastlane/Fastfile", # The path of the Fastfile in the repository.
      version: "~> 1.0.0" # The version to checkout on the repository. Optimistic match operator can be used to select the latest version within constraints.
    )',
    'import_from_git(
      url: "[email protected]:fastlane/fastlane.git", # The URL of the repository to import the Fastfile from.
      branch: "HEAD", # The branch to checkout on the repository.
      path: "fastlane/Fastfile", # The path of the Fastfile in the repository.
      version: [">= 1.1.0", "< 2.0.0"], # The version to checkout on the repository. Multiple conditions can be used to select the latest version within constraints.
      cache_path: "~/.cache/fastlane/imported" # A directory in which the repository will be added, which means that it will not be cloned again on subsequent calls.
    )'
  ]
end

.is_supported?(platform) ⇒ Boolean

Returns:



56
57
58
 
# File 'fastlane/lib/fastlane/actions/import_from_git.rb', line 56

def self.is_supported?(platform)
  true
end

.run(params) ⇒ Object 



4
5
6
 
# File 'fastlane/lib/fastlane/actions/import_from_git.rb', line 4

def self.run(params)
  # this is implemented in the fast_file.rb
end