History

Elliott Williams 66f13bfc26 Use popen2 in oss-check Ruby's documentation mentions that `popen3` requires that you flush stderr to prevent deadlocking: > You should be careful to avoid deadlocks. Since pipes are fixed length > buffers, ::popen3(“prog”) {\|i, o, e, t\| o.read } deadlocks if the > program generates too much output on stderr. You should read stdout and > stderr simultaneously (using threads or IO.select). However, if you > don't need stderr output, you can use ::popen2.		2019-07-13 11:14:09 -07:00
..
LICENSE.md	First commit	2015-05-16 18:58:10 +02:00
README.md	First commit	2015-05-16 18:58:10 +02:00
Version.swift.template	Remove all file headers	2018-05-04 13:42:02 -07:00
bootstrap	Stop `make` if working tree does not have git repository	2016-10-10 22:00:50 +09:00
check-xcode-version	First commit	2015-05-16 18:58:10 +02:00
cibuild	First commit	2015-05-16 18:58:10 +02:00
extract-tool	First commit	2015-05-16 18:58:10 +02:00
oss-check	Use popen2 in oss-check	2019-07-13 11:14:09 -07:00

README.md

objc-build-scripts

This project is a collection of scripts created with two goals:

To standardize how Objective-C projects are bootstrapped after cloning
To easily build Objective-C projects on continuous integration servers

Scripts

Right now, there are two important scripts: bootstrap and cibuild. Both are Bash scripts, to maximize compatibility and eliminate pesky system configuration issues (like setting up a working Ruby environment).

The structure of the scripts on disk is meant to follow that of a typical Ruby project:

script/
    bootstrap
    cibuild

bootstrap

This script is responsible for bootstrapping (initializing) your project after it's been checked out. Here, you should install or clone any dependencies that are required for a working build and development environment.

By default, the script will verify that xctool is installed, then initialize and update submodules recursively. If any submodules contain script/bootstrap, that will be run as well.

To check that other tools are installed, you can set the REQUIRED_TOOLS environment variable before running script/bootstrap, or edit it within the script directly. Note that no installation is performed automatically, though this can always be added within your specific project.

cibuild

This script is responsible for building the project, as you would want it built for continuous integration. This is preferable to putting the logic on the CI server itself, since it ensures that any changes are versioned along with the source.

By default, the script will run bootstrap, look for any Xcode workspace or project in the working directory, then build all targets/schemes (as found by xcodebuild -list) using xctool.

You can also specify the schemes to build by passing them into the script:

script/cibuild ReactiveCocoa-Mac ReactiveCocoa-iOS

As with the bootstrap script, there are several environment variables that can be used to customize behavior. They can be set on the command line before invoking the script, or the defaults changed within the script directly.

Getting Started

To add the scripts to your project, read the contents of this repository into a script folder:

$ git remote add objc-build-scripts https://github.com/jspahrsummers/objc-build-scripts.git
$ git fetch objc-build-scripts
$ git read-tree --prefix=script/ -u objc-build-scripts/master

Then commit the changes, to incorporate the scripts into your own repository's history. You can also freely tweak the scripts for your specific project's needs.

To merge in upstream changes later:

$ git fetch -p objc-build-scripts
$ git merge --ff --squash -Xsubtree=script objc-build-scripts/master