gradle plugin for building Xcode Projects for iOS, watchOS, macOS or tvOS
Groovy Objective-C Other
Latest commit 455b113 Feb 3, 2017 @renep renep committed on GitHub Merge pull request #336 from openbakery/revert-334-ben/subproject
Revert "Append projectFile to projectDir"

README.md

gradle-xcodePlugin

Build Status Coverage Status

Join the gradle-xcode-plugin Slack channel for questions and discussions. Send me a mail (rene@openbakery.org) and I will send you an invitation

The gradle xcode plugin (gxp) makes it easier to build Xcode projects by specifying the build settings in a single configuration file. The goal is to keep the build file as simple as possible, but also enable a great flexibility for the build.

The gxp uses the Apple command line tools (like xcodebuild) to perform the build.

Here a brief overview of the features:

Note

Version 0.14 of the plugin needs at least gradle version 2.14

Version 0.13+ will not work with gradle version 2.14

Requirements

  • Xcode 6 or greater
  • Gradle 2.14 or greater
  • Java 1.6 or greater

Current stable version is 0.14.5

0.12.x supports Xcode 6.+ and Xcode 7.+

Documentation

Usage

Create a build.gradle file and place it in the same directory where xcodeproj file lies.

Here the minimal content you need in your build.gradle file:

plugins {
  id "org.openbakery.xcode-plugin" version "0.14.5"
}

xcodebuild {
  scheme = 'MY-SCHEMA'
  target = 'MY-TARGET'
}

You can also use the version that is deployed the repository on openbakery.org with the following build.gradle file configuration:

buildscript {
	repositories {
		maven {
			url('http://repository.openbakery.org/')
		}
		mavenCentral()
  }

	dependencies {
	    classpath "org.openbakery:xcode-plugin:0.14.+"
	}
}

apply plugin: "org.openbakery.xcode-plugin"

Current develop version

When using the openbakery.org repository you can also get the latest develop version by including develop into the version pattern. e.g.:

classpath "org.openbakery:xcode-plugin:0.14.5.develop.+"

The develop version contains all the changes from the develop branch, where all the fixes and feature are implemented. The development version is deployed automatically when all the projects unit tests are successful, and also the if the example projects build.

Example

You find example projects in example/ with a working build.gradle file. After you have fetched the example go to the example/iOS/Example directory and you build the project different targets:

  • Build with gradle xcodebuild
  • Run the unit tests with gradle test
  • Perform a device build and upload it to hockeyapp with gradle integration. Here you need to specify your sign settings first (see Signing ). Open the build.gradle file an follow the instructions.
  • Perform an appstore build with gradle appstore. (Also the sign settings are needed).

Collaborate

I'm always happy to receive pull requests with new features and if you send a pull request please consider the following things:

  • Use the develop branch for pull requests, because all the new stuff is implemented in the develop branch and also pull requests are always merge into develop
  • Use Tabs instead of spaces.
  • Make sure that all unit tests are working before you send the pull request. Just run 'gradle test'
  • I urge you to write unit tests.
  • For unit test please use the spock framework for mocking. I want to remove the old gmock framework and port the old tests to use spock.
  • If a pull request does not contain any unit tests, I always think twice if I should merge it at all.

Migration Notes

With version 0.12 the sdk parameter was removed and was replaced by the new type and simulator parameter

Here a table of the values for the migration to 0.12:

sdk (old) type (new) simulator (new)
iphonesimulator iOS true
iphoneos iOS false
macosx OSX (this value is ignored)

License

This project is licensed under the terms of the Apache license. See the LICENSE file.