class Fastlane::Actions::ZipAction

Public Class Methods

authors() click to toggle source
# File fastlane/lib/fastlane/actions/zip.rb, line 111
def self.authors
  ["KrauseFx"]
end
available_options() click to toggle source
# File fastlane/lib/fastlane/actions/zip.rb, line 43
def self.available_options
  [
    FastlaneCore::ConfigItem.new(key: :path,
                                 env_name: "FL_ZIP_PATH",
                                 description: "Path to the directory or file to be zipped",
                                 verify_block: proc do |value|
                                   UI.user_error!("Couldn't find file/folder at path '#{File.expand_path(value)}'") unless File.exist?(value)
                                 end),
    FastlaneCore::ConfigItem.new(key: :output_path,
                                 env_name: "FL_ZIP_OUTPUT_NAME",
                                 description: "The name of the resulting zip file",
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :verbose,
                                 env_name: "FL_ZIP_VERBOSE",
                                 description: "Enable verbose output of zipped file",
                                 default_value: true,
                                 type: Boolean,
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :password,
                                 env_name: "FL_ZIP_PASSWORD",
                                 description: "Encrypt the contents of the zip archive using a password",
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :symlinks,
                                 env_name: "FL_ZIP_SYMLINKS",
                                 description: "Store symbolic links as such in the zip archive",
                                 optional: true,
                                 type: Boolean,
                                 default_value: false)
  ]
end
category() click to toggle source
# File fastlane/lib/fastlane/actions/zip.rb, line 95
def self.category
  :misc
end
description() click to toggle source

@!group Documentation

# File fastlane/lib/fastlane/actions/zip.rb, line 39
def self.description
  "Compress a file or folder to a zip"
end
example_code() click to toggle source
# File fastlane/lib/fastlane/actions/zip.rb, line 74
def self.example_code
  [
    'zip',
    'zip(
      path: "MyApp.app",
      output_path: "Latest.app.zip"
    )',
    'zip(
      path: "MyApp.app",
      output_path: "Latest.app.zip",
      verbose: false
    )',
    'zip(
      path: "MyApp.app",
      output_path: "Latest.app.zip",
      verbose: false,
      symlinks: true
    )'
  ]
end
is_supported?(platform) click to toggle source
# File fastlane/lib/fastlane/actions/zip.rb, line 115
def self.is_supported?(platform)
  true
end
output() click to toggle source
# File fastlane/lib/fastlane/actions/zip.rb, line 99
def self.output
  []
end
return_type() click to toggle source
# File fastlane/lib/fastlane/actions/zip.rb, line 107
def self.return_type
  :string
end
return_value() click to toggle source
# File fastlane/lib/fastlane/actions/zip.rb, line 103
def self.return_value
  "The path to the output zip file"
end
run(params) click to toggle source
# File fastlane/lib/fastlane/actions/zip.rb, line 4
def self.run(params)
  UI.message("Compressing #{params[:path]}...")

  params[:output_path] ||= params[:path]

  absolute_output_path = File.expand_path(params[:output_path])

  # Appends ".zip" if path does not end in ".zip"
  unless absolute_output_path.end_with?(".zip")
    absolute_output_path += ".zip"
  end

  absolute_output_dir = File.expand_path("..", absolute_output_path)
  FileUtils.mkdir_p(absolute_output_dir)

  Dir.chdir(File.expand_path("..", params[:path])) do # required to properly zip
    zip_options = params[:verbose] ? "r" : "rq"
    zip_options += "y" if params[:symlinks]

    if params[:password]
      password_option = "-P '#{params[:password]}'"
      Actions.sh("zip -#{zip_options} #{password_option} #{absolute_output_path.shellescape} #{File.basename(params[:path]).shellescape}")
    else
      Actions.sh("zip -#{zip_options} #{absolute_output_path.shellescape} #{File.basename(params[:path]).shellescape}")
    end
  end

  UI.success("Successfully generated zip file at path '#{File.expand_path(absolute_output_path)}'")
  return File.expand_path(absolute_output_path)
end