class Pantograph::Actions::ImportFromGitAction

Public Class Methods

authors() click to toggle source
# File pantograph/lib/pantograph/actions/import_from_git.rb, line 56
def self.authors
  ['fabiomassimo', 'KrauseFx', 'Liquidsoul', 'johnknapprs']
end
available_options() click to toggle source
# File pantograph/lib/pantograph/actions/import_from_git.rb, line 20
def self.available_options
  [
    PantographCore::ConfigItem.new(
      key: :url,
      description: 'The URL of the repository to import the Pantfile from',
      default_value: nil,
      optional: false
    ),
    PantographCore::ConfigItem.new(
      key: :branch,
      description: 'The branch or tag to check-out on the repository',
      default_value: 'master',
      optional: true
    ),
    PantographCore::ConfigItem.new(
      key: :path,
      description: 'The path of the Pantfile in the repository',
      default_value: 'pantograph/Pantfile',
      optional: true
    ),
    PantographCore::ConfigItem.new(
      key: :dependencies,
      description: 'Array of additional Pantfiles in the repository',
      default_value: [],
      optional: true
    ),
    PantographCore::ConfigItem.new(
      key: :version,
      description: 'The version to checkout on the repository. Optimistic match operator or multiple conditions can be used to select the version within constraints',
      default_value: nil,
      is_string: false,
      optional: true
    )
  ]
end
category() click to toggle source
# File pantograph/lib/pantograph/actions/import_from_git.rb, line 89
def self.category
  :misc
end
description() click to toggle source

@!group Documentation

# File pantograph/lib/pantograph/actions/import_from_git.rb, line 12
def self.description
  'Import another Pantfile from a remote git repository to use its lanes'
end
details() click to toggle source
# File pantograph/lib/pantograph/actions/import_from_git.rb, line 16
def self.details
  'This is useful when sharing the same lanes across multiple projects'
end
example_code() click to toggle source
# File pantograph/lib/pantograph/actions/import_from_git.rb, line 64
def self.example_code
  [
    ' # Simple import on master branch
      import_from_git(
        url: "git@github.com:urbanquakers/pantograph.git"
      )
    ',
    ' # Import a Pantfile with an Optimistic version match operator
      import_from_git(
        url: "git@github.com:urbanquakers/pantograph.git",
        branch: "master",
        path: "pantograph/Pantfile",
        version: "~> 1.0.0"
      )
    ',
    ' # Import a Pantfile with multiple version conditions
      import_from_git(
        url: "git@github.com:urbanquakers/pantograph.git", # The URL of the repository to import the Pantfile from.
        branch: "development", # The branch to checkout on the repository
        version: [">= 1.1.0", "< 2.0.0"]
      )
    '
  ]
end
is_supported?(platform) click to toggle source
# File pantograph/lib/pantograph/actions/import_from_git.rb, line 60
def self.is_supported?(platform)
  true
end
run(params) click to toggle source
# File pantograph/lib/pantograph/actions/import_from_git.rb, line 4
def self.run(params)
  # this is implemented in the pant_file.rb
end