zip

Compress a file or folder to a zip

zip
Supported platforms ios, android, mac
Author @KrauseFx
Returns The path to the output zip file

6 Examples

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
)
zip(
  path: "./",
  output_path: "Source Code.zip",
  exclude: [".git/*"]
)
zip(
  path: "./",
  output_path: "Swift Code.zip",
  include: ["**/*.swift"],
  exclude: ["Package.swift", "vendor/*", "Pods/*"]
)

Parameters

Key Description Default
path Path to the directory or file to be zipped
output_path The name of the resulting zip file
verbose Enable verbose output of zipped file true
password Encrypt the contents of the zip archive using a password
symlinks Store symbolic links as such in the zip archive false
include Array of paths or patterns to include []
exclude Array of paths or patterns to exclude []

* = default value is dependent on the user's system


Documentation

To show the documentation in your terminal, run

fastlane action zip

CLI

It is recommended to add the above action into your Fastfile, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal

fastlane run zip

To pass parameters, make use of the : symbol, for example

fastlane run zip parameter1:"value1" parameter2:"value2"

It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. param:"1,2,3"). Hashes are not currently supported.

It is recommended to add all fastlane actions you use to your Fastfile.


Source code

This action, just like the rest of fastlane, is fully open source, view the source code on GitHub


Back to actions