Initial implementation.

Author: bejo

README.md

@@ -1,4 +1,30 @@
+
 XcodeIconTagger
 ===============
 
-Adds version and commit hash as an overlay to your iOS app's icon.
+The XcodeIconTagger can add a version number and a GIT commit hash (or any other text) as an overlay to your iOS app's icon. This can be really useful for beta/AdHoc builds, just a glimpse at Springboard can reveal which version of your app is installed on a device! The idea for this tool came from Evan Doll who presented it at NSConference #5 as a part of development setup that Flipboard is using.
+
+## Usage
+
+The entry point of the tagger is tagIcons.sh script, which takes two arguments:
+
+tagIcons.sh <command> [path-to-icons-directory]
+
+The two available commands are:
+
+* _tag_ - tags icons with version number and commit hash
+* _cleanup_ - checkouts the icons to their original state
+
+The script is designed to be run as one of Xcode build phases. It uses environmental variables to retrieve application version and icons file names from application's Info Plist file (since the plist doesn't include full paths you still need to provide the base path to icons directory).
+
+The easiest way to integrate XcodeIconTagger with your project is by adding two scripts to build phases, one at the very beginning:
+
+if [ $CONFIGURATION == "Release" ] ; then
+ ${SRCROOT}/XcodeIconTagger/tagIcons.sh tag MyApp/Images
+fi
+
+and one at the very end:
+
+if [ $CONFIGURATION == "Release" ] ; then
+ ${SRCROOT}/XcodeIconTagger/tagIcons.sh cleanup MyApp/Images
+fi

tagIcons.sh

@@ -0,0 +1,43 @@
+#!/bin/bash
+
+commit=`git rev-parse --short HEAD`
+version=`/usr/libexec/PlistBuddy -c "Print CFBundleShortVersionString" "${INFOPLIST_FILE}"`
+
+mode=$1
+tagMode="tag"
+cleanupMode="cleanup"
+
+iconsDirectory=`cd $2 && pwd`
+icons=(`/usr/libexec/PlistBuddy -c "Print CFBundleIconFiles" "${INFOPLIST_FILE}" | grep png | tr -d '\n'`)
+
+taggerDirectory=`dirname $0`
+taggerPlist="tagImage.workflow/Contents/document.wflow"
+paramsPath=":actions:0:action:ActionParameters"
+
+iconsCount=${#icons[*]}
+for (( i=0; i<iconsCount; i++ ))
+do
+ icon="$iconsDirectory/${icons[$i]}"
+
+ if [ -f $icon ]; then
+ height=`sips -g pixelHeight $icon | tail -n 1 | sed "s/ *pixelHeight: */ /"`
+ width=`sips -g pixelWidth $icon | tail -n 1 | sed "s/ *pixelWidth: */ /"`
+
+ if (( $height == $width )); then
+ if [ $mode == $tagMode ]; then
+ renderSize=$(( $width * 4 )) # for some reason it looks much better when rendering canvas are bigger than an icon
+ renderSize=$(( $renderSize + $width%2 )) # rendering canvas for odd sized images should also be odd
+
+ cd $taggerDirectory
+ /usr/libexec/PlistBuddy -c "Set $paramsPath:renderPixelsHigh $renderSize" -c "Set $paramsPath:renderPixelsWide $renderSize" $taggerPlist
+ automator -D text=$version$'\n'$commit -D image=$icon -i tagImage.qtz tagImage.workflow > /dev/null
+ git checkout $taggerPlist
+
+ sips --cropToHeightWidth $height $width tagImage.png > /dev/null
+ mv tagImage.png $icon
+ elif [ $mode == $cleanupMode ]; then
+ git checkout $icon
+ fi
+ fi
+ fi
+done