| master | develop | versioning | license | contributing |
|---|---|---|---|---|
 |
 |
 |
 |
 |
- Xcode 9.2.
- ruby 2.3.x - ruby > 2.3 is not supported.
Maintainers must install the calabash/calabash-codesign private repo. Details are below.
All build products are staged to the ./Products directory - even when building from Xcode.
To build the DeviceAgent-Runner.app from Xcode, select the DeviceAgent scheme and Build for Testing (Shift + Command + U). Rinse and repeat for simulator or device targets. This will generate binaries for distribution in the ./Products directory. The post-build staging is done in the DeviceAgent scheme's Build Post Action Script.
The logs for this script can be found here:
/tmp/CBX-Runner-post-build.log
Inspect that log file for code signing, patching, and staging errors.
The application targets can be built as usual (Command + B).
You should never have to build the UnitTest target for distribution.
$ git clone [email protected]:calabash/DeviceAgent.iOS.git ios-device-agent
$ cd ios-device-agent
$ bundle install
# Make the agent ipa and app
$ make ipa-agent
$ make app-agent
# Unit tests; running against simulators
$ make unit-tests
# Cucumber integration tests
$ make test-app
$ cd cucumber
$ bundle update
$ be cucumber
To build with an alternative Xcode:
$ DEVELOPER_DIR=/Xcode/7.3/Xcode-beta.app make < rule >
If you have build errors, see the xcpretty section below.
If you are a maintainer, you must install the codesign tool.
If see messages like this:
iPhone Developer: ambiguous matches
then you must either:
$ CODE_SIGN_IDENTITY="< cert name >" make ipa-cal(preferred)- Update the Xcode project with a specific Code Signing entity. DO NOT CHECK THESE CHANGES INTO GIT.
Maintainers should be using the Calabash.keychain (calabash/calabash-codesign).
Ambiguous matches usually mean that the certs are contained in both your login.keychain and the Calabash.keychain. Delete the certs in your login.keychain.
# appledoc is not available for Xcode 9.3
$ make docs
$ open documentation/html/hierarchy.html
- The Calabash iOS Toolchain uses git-flow.
- Contributors should not bump the version.
- See the CONTRIBUTING.md guide.
- There is a style guide: STYLE_GUIDE.md.
- Pull-requests with unit tests will be merged faster.
- Pull-requests with Cucumber integration tests will be merged even faster.
See the CONTRIBUTING.md document for instructions.
https://github.com/supermarin/xcpretty
We use xcpretty to make builds faster and to reduce the amount of logging. Travis CI, for example, has a limit on the number of lines of logging that can be generated; xcodebuild breaks this limit.
The only problem with xcpretty is that it does not report build errors very well. If you encounter an issue with any of the make rules, run without xcpretty:
$ XCPRETTY=0 make ipa-agent
DeviceAgent uses several third-party sources. You can find the licenses for these sources in the Licenses directory.