iOS Orb

Badges	Insights

A CircleCI orb for iOS development that provides reusable commands, jobs, and executors for building, testing, and deploying iOS applications.

Features

• macOS executor with configurable Xcode version and resource class
• Ruby/Bundler setup with caching
• Swift Package Manager (SPM) caching
• Homebrew formula installation with caching
• Code Climate test coverage integration
• Fastlane lane execution
• Build artifact storage

Requirements

• CircleCI account with macOS execution environment access
• Xcode project or workspace

Usage

Add the orb to your .circleci/config.yml:

version: 2.1

orbs:
    ios: kevnm67/ios-orb@1.0.0

workflows:
    build-test:
        jobs:
            - ios/run_with_setup:
                  name: build_and_test
                  scripts:
                      - run: bundle exec fastlane test

Executors

macos

macOS executor with Xcode support.

Parameter	Type	Default	Description
xcode_version	string	26.2.0	Xcode version to use
resource_class	string	m4pro.medium	macOS resource class

jobs:
    build:
        executor:
            name: ios/macos
            xcode_version: "26.2.0"
            resource_class: m4pro.medium

Jobs

run_with_setup

Run scripts or commands with automatic environment setup including checkout, workspace attachment, Ruby/Bundler installation, and SPM cache restoration.

Parameter	Type	Default	Description
xcode_version	string	26.2.0	Xcode version
resource_class	string	m4pro.medium	macOS resource class
checkout	boolean	true	Whether to checkout code
attach_workspace	boolean	true	Whether to attach workspace
scripts	steps	[]	Steps to run after setup
xcode_project	string	""	Xcode project name for SPM cache

test

Run tests with Code Climate coverage reporting.

Parameter	Type	Default	Description
xcode_version	string	26.2.0	Xcode version
resource_class	string	m4pro.medium	macOS resource class
lane	string	""	Fastlane lane to run
pretest_steps	steps	[]	Steps before testing
test_steps	steps	[]	Custom test steps

Commands

setup

Initialize the build environment with checkout, workspace attachment, Ruby installation, and dependency caching.

lane

Execute a Fastlane lane.

steps:
    - ios/lane:
          named: test

brew_install

Install Homebrew formulas with optional caching.

cache_spm / restore_spm_cache

Cache and restore Swift Package Manager dependencies.

save_build_artifacts

Store build logs, diagnostic reports, and test results as CircleCI artifacts.

Orb Dependencies

This orb uses the following CircleCI orbs:

• circleci/macos@2.5.2 - macOS utilities
• circleci/ruby@2.6.0 - Ruby installation and caching

Resources

• CircleCI Orb Registry - Official registry page
• CircleCI Orb Docs - Documentation for using and creating orbs

Contributing

We welcome issues and pull requests!

Publishing Updates

1. Merge pull requests with desired changes to the main branch
   • Use Conventional Commit Messages for best experience
2. Check the current version: circleci orb info kevnm67/ios-orb | grep "Latest"
3. Create a new Release on GitHub
   • Create a semantically versioned tag (e.g., v1.0.0)
4. Click "Auto-generate release notes"
5. Verify the version tag is semantically accurate
6. Click "Publish Release" to trigger the publishing pipeline