Skip to content

Latest commit

 

History

History
140 lines (97 loc) · 3.2 KB

Cache.md

File metadata and controls

140 lines (97 loc) · 3.2 KB
Raw

🏈 Cache

OVERVIEW: Convert pods to prebuilt dependencies.

OPTIONS:
  -a, --arch <arch>         Build architectures. (default: sim x86_64, ios arm64)
  -c, --config <config>     Build configuration. (default: Debug)
  -s, --sdk <sdk>           Build sdks: sim/ios or both. (default: sim)
  --bitcode                 Add bitcode for archive builds.
  -k, --keep-sources        Keep Pods group in project.
  -e, --exclude <exclude>   Exclude pods from cache.
  --include <include>       Include local pods.
  --focus <focus>           Keep selected local pods and cache others.
  --ignore-checksums        Ignore already cached pods checksums.
  --graph                   Add parents of changed pods to build process.

  --bell/--no-bell          Play bell sound on finish. (default: true)
  --hide-metrics            Hide metrics.
  -v, --verbose             Print more information.
  -q, --quiet               Print nothing.
  --version                 Show the version.
  -h, --help                Show help information.

General usage

Call it after each pod install or pod update:

pod install && rugby

Build for simulator (by default)

It's all the same:

rugby
rugby cache
rugby cache -s sim
rugby cache -s sim -a x86_64
rugby cache --sdk sim --arch x86_64

Keep Pods group in project

rugby --keep-sources

Exclude pods from cache

rugby --exclude Alamofire SnapKit

Build for device (arm64)

rugby --sdk ios

Build both sdks (sim x86_64, ios arm64)

It's all the same:

rugby -s sim ios
rugby --sdk sim ios --arch x86_64 arm64

Build for specific configuration

rugby --config Debug

Build for AppStore (for example)

rugby --config Release --sdk ios --bitcode

Build local pods

You can include some local pods to cache:

rugby --include MyLocalPods1 MyLocalPods2

If you want to focus on some local pods and cache all others:

rugby --focus MyFocusedPod1 MyFocusedPod2

If you want to cache all local pods (Maybe someday there will be another solution):

rugby --focus ""

Ignore checksums

Rugby has cache file at .rugby/cache.yml. There keep checksums and other build settings. During each run Rugby try to save your time and do not pass all targets to Xcode building process. But sometimes something can get wrong.

If you have troubles with the building process you can try to use that flag. It will ignore CocoaPods checksums and add all targets to Xcode build process. Also will be great if you report about that in the discussions sections. It can help to improve the cache system.

rugby --ignore-checksums

Graph flag

When checksums of some pods changes, there can be parents whose checksum still unchanged. Sometimes those changes can break the building process. But it's a rare case. On the other hand, the rebuilding all parent spend a lot of time.

Please, report in the discussions section if you have some troubles building in Xcode after using Rugby. And pass this flag as a workaround:

rugby --graph