setup-xcode

This action is intended to switch between pre-installed versions of Xcode for macOS images in GitHub Actions.

The list of all available versions can be found in runner-images repository.

Available parameters

Argument	Description	Format
xcode-version	Specify the Xcode version to use	- latest or - latest-stable or - SemVer string or - <semver>-beta

Notes:

• latest-stable points to the latest stable version of Xcode
• latest includes beta releases that GitHub actions has installed
• SemVer examples: 14, 14.1, 14.3.1, ^14.3.0 (find more examples in SemVer cheatsheet)
• -beta suffix after SemVer will only select among beta releases that GitHub actions has installed
• If sets a specific version, wraps it to single quotes in YAML like '12.0' to pass it as string because GitHub trimmes trailing .0 from numbers
• If the xcode-version argument is omitted, the version is read from the file .xcode-version at the root of the repository
• xcode-version defaults to latest when no argument or .xcode-version file is present.

Usage

Set the Xcode version based on the contents of the .xcode-version file:

jobs:
  build:
    runs-on: macos-latest
    steps:
    - uses: nomasystems/[email protected]

Set the latest stable Xcode version:

jobs:
  build:
    runs-on: macos-latest
    steps:
    - uses: nomasystems/[email protected]
      with:
        xcode-version: latest-stable

Set the latest Xcode version including beta releases:

jobs:
  build:
    runs-on: macos-latest
    steps:
    - uses: nomasystems/[email protected]
      with:
        xcode-version: latest

Set the specific stable version of Xcode:

jobs:
  build:
    runs-on: macos-14
    steps:
    - uses: nomasystems/[email protected]
      with:
        xcode-version: '15.4'

Set the specific beta version of Xcode:

jobs:
  build:
    runs-on: macos-14
    steps:
    - uses: nomasystems/[email protected]
      with:
        xcode-version: '16.1-beta'

How it works

1. Enumerates apps named Xcode.*.app in the /Applications directory
   • The version information for each app version is parsed from its plist files
2. The requested semantic version is matched against the available app versions
3. Exports the environment variable DEVELOPER_DIR (see man xcode-select) with the path to the matched Xcode app

License

The scripts and documentation in this project are released under the MIT License