Getting Started

Getting Started

Table of Contents

• Requirements
• Installation
• Quick Start: Xcode Project
• Quick Start: SPM Package
• Quick Start: Fastlane Lane
• Environment Variables

---

Requirements

• CircleCI account with macOS execution environment access
• Xcode project, workspace, or Swift package
• Ruby/Bundler (for Fastlane-based workflows)
• QLTY_COVERAGE_TOKEN set in your CircleCI project or context (obtain from qlty.sh project settings)

---

Installation

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

version: 2.1

orbs:
  ios-orb: kevnm67/ios-orb@3.0.0

Use the alias ios-orb to match all examples in this wiki.

---

Quick Start: Xcode Project

The build_and_test_xcode job covers the full lifecycle — optional XcodeGen, build, test, coverage export, and Qlty upload in a single job:

version: 2.1
orbs:
  ios-orb: kevnm67/ios-orb@3.0.0
workflows:
  ci:
    jobs:
      - ios-orb/build_and_test_xcode:
          scheme: MyApp
          xcode_version: "26.3.0"
          destination: "platform=iOS Simulator,name=iPhone 16"
          xcodegen: true
          xcode_project: MyApp
          qlty: true
          context: ios_auth

---

Quick Start: SPM Package

version: 2.1
orbs:
  ios-orb: kevnm67/ios-orb@3.0.0
workflows:
  ci:
    jobs:
      - ios-orb/build_and_test_spm:
          xcode_version: "26.3.0"
          qlty: true
          context: ios_auth

---

Quick Start: Fastlane Lane

For Fastlane-based pipelines use run_with_setup for setup and test for the test + coverage phase:

version: 2.1
orbs:
  ios-orb: kevnm67/ios-orb@3.0.0
workflows:
  pr:
    jobs:
      - ios-orb/run_with_setup:
          name: setup
          xcode_version: "26.3.0"
          xcode_project: MyApp
          scripts:
            - ios-orb/install_tools:
                tools: xcodegen swiftlint
            - ios-orb/xcodegen
      - ios-orb/run_with_setup:
          name: lint
          attach_workspace: true
          checkout: false
          scripts:
            - ios-orb/swiftlint:
                strict: true
          requires:
            - setup
      - ios-orb/test:
          name: test
          xcode_version: "26.3.0"
          xcode_project: MyApp
          lane: test
          result_bundle_path: TestResults.xcresult
          coverage_file: coverage.xml
          requires:
            - setup
          context: ios_auth

---

Environment Variables

Variable	Where	Description
QLTY_COVERAGE_TOKEN	CircleCI context	Qlty project coverage token (required for upload_qlty_coverage)
MATCH_PASSWORD	CircleCI context	Fastlane Match encryption password
FASTLANE_USER	CircleCI context	Apple ID for App Store Connect