backup_xcarchive
Save your [zipped] xcarchive elsewhere from default path
| backup_xcarchive | |
|---|---|
| Supported platforms | ios, mac |
| Author | @dral3x |
1 Example
backup_xcarchive(
xcarchive: "/path/to/file.xcarchive", # Optional if you use the `xcodebuild` action
destination: "/somewhere/else/", # Where the backup should be created
zip_filename: "file.xcarchive", # The name of the backup file
zip: false, # Enable compression of the archive. Defaults to `true`.
versioned: true # Create a versioned (date and app version) subfolder where to put the archive
)
Parameters
| Key | Description | Default |
|---|---|---|
xcarchive |
Path to your xcarchive file. Optional if you use the xcodebuild action |
* |
destination |
Where your archive will be placed | |
zip |
Enable compression of the archive | true |
zip_filename |
Filename of the compressed archive. Will be appended by .xcarchive.zip. Default value is the output xcarchive filename |
* |
versioned |
Create a versioned (date and app version) subfolder where to put the archive | true |
* = default value is dependent on the user's system
Lane Variables
Actions can communicate with each other using a shared hash lane_context, that can be accessed in other actions, plugins or your lanes: lane_context[SharedValues:XYZ]. The backup_xcarchive action generates the following Lane Variables:
| SharedValue | Description |
|---|---|
SharedValues::BACKUP_XCARCHIVE_FILE |
Path to your saved xcarchive (compressed) file |
To get more information check the Lanes documentation.
Documentation
To show the documentation in your terminal, run
fastlane action backup_xcarchive
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 backup_xcarchive
To pass parameters, make use of the : symbol, for example
fastlane run backup_xcarchive 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