9

I do not want an Archive build to succeed unless my working directory is clean. Therefore, I want to add a "Run Script" build phase (or something similar) to my Xcode project such that:

IF I am performing an Archive build...

AND there are uncommitted changes in my source directory

THEN the build fails with an error.

I'm working with Xcode 4 and git 1.7.

What's a good, concise, reusable script that will do the job?

benzado
  • 82,288
  • 22
  • 110
  • 138

1 Answers1

10

Here's the script I've come up with:

#!/bin/sh
if [ -z "$(git status --porcelain)" ]; then
    TAG=`date +xcarchive-%Y%m%d-%H%M%S`
    echo "Working directory clean, creating tag ${TAG}"
    git tag -a -m "Xcode Archive created" ${TAG}
    exit 0
else
    echo "error: Working directory dirty, stopping build"
    exit 1
fi

As a bonus, it creates a tag if the working copy is clean.

The clean/dirty check is based on this question (which I forgot I had proposed an answer for).

If you don't want to create a tag, remove the git tag line.

If you don't want to stop the build, remove the exit 1 line.

To install this in a project:

  1. Put this in a file in your project directory (I called it ArchiveHousekeeper.sh) and make sure the executable bit is set (chmod +x)
  2. In your Xcode Project, add a new "External Build System" target
    • Name: "Archive Housekeeper" (or whatever you like)
    • Build Tool: ./ArchiveHousekeeper.sh
  3. On the Xcode menu, select Product -> Edit Scheme...
  4. In the Build section, add the new target, then uncheck all the boxes except the one in the Archive column. This ensures the script will only be run on Archive. (See this question for an explanation and a nice screenshot.)
  5. Now try to create an archive, and watch it fail because you haven't checked in these changes!

It would be nice if Xcode 4 Pre- and Post- actions could be used for this (so you don't need to create a "fake" target), but they don't seem able to affect the build, and also I have no idea in what directory they are executed, what environment variables are available, or where their output goes.

Community
  • 1
  • 1
benzado
  • 82,288
  • 22
  • 110
  • 138
  • Thanks! It took me quite a while to work out how to [add a new target](http://stackoverflow.com/a/10407469/2547229)! – Benjohn Jul 30 '15 at 17:57
  • I'm pretty keen to be able to use build settings in the script – basically I want the [build name, version and build number in the tag](http://stackoverflow.com/q/27326469/2547229). These variables don't seem to be given to the script using this approach? – Benjohn Jul 30 '15 at 18:17
  • In Xcode 8.3.2, add an "External Build System" target via File > New > Target... > Cross-platform > External Build System. – Joshua C. Lerner May 12 '17 at 15:19