Over the years, we’ve been building loads of nicely-crafted iOS applications for our clients.
To keep everyone work closely, we send daily builds to our QA Team, beta users, clients, other team members. However, building an iOS is still painful for Project Manager — It involves compiling, uploading the app to TestFlight or HockeyApp,
setting up Crittercism for collecting crash reports (Those who have experience, should know that you have to upload dSym files for symbolic debug messages), notify everyone on Slack, etc.
Much better if we can automate all these with each Pull Request.
Overview
Our engineers came up with a Reusable iOS script for Travis CI to ease our pain. Check out the script at https://github.com/oursky/travis-ios-script
CI (Continuous Integration) is delightful
CI has delighted us (and other worldwide developers) by being able to :
- Automate the unit-testing process
- Standard build settings
- Maintain a code repository
- Build fast
- Support multiple build targets
However, whenever initiating a project, our engineers have to spare some time (and that’s not short) setting up configurations for CI, including dealing with iOS Provisioning profiles, build settings, dependencies, etc.
Upon spending time setting up a few iOS Apps,
“Are we repeating ourselves?” yelled the voice from inside.
We’ve also noticed that the bottleneck for delivering a build is at the “Developer → QA” process
In legacy time, upon a beta build delivery, the PM has to :
- Ask the developer to push code to beta branch
- Pull code from the beta branch
- Fix cert and dependencies
- Build the app
- Upload to Testflight / Hockey App
- Update dSym file at Crittercism
- Notify QA Tester / Client the build is available
By building on Travis CI, we partially saved the PM’s life by automating the building and environment configuring process.
The well-built (and tested) project build is now ready for delivery.
Why don’t we further automate the delivery stage?
Beyond Auto-building – Automating the delivery process
Our engineers prepared a reusable script that basically helps initiate the Travis CI settings for every iOS project.
With proper settings and valid API keys, the deliverable built on Travis CI will then be delivered to other App distribution platforms.
Developers only have to put required the certificates, provisioning profiles and API Keys in the corresponding directories.
Then fill in the blanks for project settings in travis.yml.
The repository also includes scripts that enable signing and uploading. Project code will be compiled upon pushing to branches, then uploaded to Testflight / HockeyApp, and the dSym files will go to Crittercism as well.
Now, the latest build will be built and delivered automatically, available for beta testing in a minute.
Oh, we even have the build result pushed to Slack. So other team members in channel could keep track on the progress.
Life gets better
Required Set-up time for Travis CI : 1 day (Before) → 30mins (After)
Steps to deliver a build : Push, pull, fix dependencies, build, upload to various places, delivered (Before) → Push, delivered (After)
Bonus: Sometimes a project could be built on Bob’s machine but not in Ada’s.
Integrating the CI process also standardizes build settings among developers (CI setting as the standard).
Yeah! That sounds really great now.
Let’s get some coffee.
How to use the script?
Checkout the repository of the Reusable iOS script at https://github.com/oursky/travis-ios-script .
You may also find guidelines setting up for your project in the project README.
Setting up the certs and provisioning profiles
- Place all encrypted cert and private key in cert directory
openssl aes-256-cbc -k “<ENCRYPTION_SECRET>” -in dist.cer -out ./certs/dist.cer.enc -a
openssl aes-256-cbc -k “<ENCRYPTION_SECRET>” -in dist.p12 -out ./certs/dist.p12.enc -a
- Place all encrypted provision profile in profile directory
openssl aes-256-cbc -k “<ENCRYPTION_SECRET>” -in <PROFILE_NAME>.mobileprovision -out ./profile/<PROFILE_NAME>.mobileprovision.enc -a
- Add encryption secret key:
travis encrypt “ENCRYPTION_SECRET=<Encryption Secret Key>” — add
- Add protection password for private key:
travis encrypt “KEY_PASSWORD=<Protection Password>” — add
Upload to TestFlight, HockeyApp and Crittercism
- Enable uploading testflight branch to iTunes Connect by iTunes Connect account:
travis encrypt “DELIVER_PASSWORD=<Password>” — add
- Enable uploading hockeyapp branch to HockeyApp by adding App ID and App Token:
travis encrypt “HOCKEY_APP_ID=<App ID>” — addtravis encrypt “HOCKEY_APP_TOKEN=<App Token>” — add
- Enable uploading dSYM file to Crittercism by adding App ID and API Key:
travis encrypt “CRITTERCISM_APP_ID=<App ID>” — addtravis encrypt “CRITTERCISM_KEY=<API Key>” — add
If you favor Travis CI for iOS project + more:
Check out the Reusable iOS script at https://github.com/oursky/travis-ios-script
We wish to see more automated integration that delights our lives.
Pull requests are welcome.