• Configure the system
• Build Swift Compiler
  • Build Swift compiler without additional tools
  • Build Swift Compiler with Sccache
  • Build Swift stdlib against a downloadable toolchain
• Build swift-corelibs-foundation
• Good first issues

Configure the system

Requirements

• macOS 10.14.4 or later
• Xcode 11 beta 1
• 60 GB of free disk space

Install Xcode

• Download Xcode 11 beta 1 and select Applications
• Double click on the XIP image
• Move the Xcode-beta.app to /Applications/

mv ~/Downloads/Xcode-beta.app /Applications/

• xcode-select the Xcode 11 beta 1

xcode-select -s /Applications/Xcode-beta.app

Install CMake and Ninja

• Install CMake using package manager [1]
• Homebrew

brew install cmake ninja

• MacPorts

port install cmake ninja

Setup Swift Repositories

• Clone Swift repository

git clone git@github.com:swiftlang/swift.git

• Clone other required repositories

./swift/utils/update-checkout --clone --scheme main

Build Swift Compiler

Build Swift compiler without additional tools

• Build Swift Compiler:

./swift/utils/build-script --build-ninja --release-debuginfo

Build Swift Compiler with Sccache

• Install sccache using Homebrew [2]

brew install sccache

• Set sccache server URL

export SCCACHE_REDIS=${SCCACHE_REDIS}

• Start sccache server

sccache  --start-server

• Build Swift Compiler:

./swift/utils/build-script \
    --cmake-c-launcher `which sccache` \
    --cmake-cxx-launcher `which sccache` \
    --preset=buildbot_incremental,tools=RA,stdlib=RD,build

• Stop sccache server

sccache  --stop-server

Build Swift stdlib against a downloadable toolchain

• Create a workspace directory

mkdir workspace
cd workspace

• Download the following snapshot from swift.org: https://download.swift.org/development/xcode/swift-DEVELOPMENT-SNAPSHOT-2019-06-06-a/swift-DEVELOPMENT-SNAPSHOT-2019-06-06-a-osx.pkg

curl -O https://download.swift.org/development/xcode/swift-DEVELOPMENT-SNAPSHOT-2019-06-06-a/swift-DEVELOPMENT-SNAPSHOT-2019-06-06-a-osx.pkg

• Untar the file using the commands into workspace/toolchain

mkdir toolchain
xar -C toolchain -x -f swift-DEVELOPMENT-SNAPSHOT-2019-06-06-a-osx.pkg
tar -C toolchain -xzf toolchain/swift-DEVELOPMENT-SNAPSHOT-2019-06-06-a-osx-package.pkg/Payload
TOOLCHAIN_BIN_DIR=$PWD/toolchain/usr/bin

• Clone Swift repository:

git clone git@github.com:swiftlang/swift.git

• Clone other required repositories:

./swift/utils/update-checkout --clone --scheme=stdlib_standalone

• Build the swift stdlib using one of the presets from the chart below. We suggest for development to try stdlib_DA_standalone,build. The form of the build-script invocation is:

  • To build/test

      ./swift/utils/build-script --preset=$PRESET_NAME toolchain_path=$TOOLCHAIN_BIN_DIR
    

  • To reconfigure (rerun cmake), pass in the reconfigure flag.

      ./swift/utils/build-script --preset=$PRESET_NAME toolchain_path=$TOOLCHAIN_BIN_DIR --reconfigure
    

  • Example:

      ./swift/utils/build-script --preset=stdlib_DA_standalone,build toolchain_path=$TOOLCHAIN_BIN_DIR
    

  • To clean remove ./workspace/build/$PRESET_STEM. Example:

      rm -rfv build/stdlib_DA_standalone
    

Build swift-corelibs-foundation

build swift-corelibs-foundation against a downloadable toolchain

• Download and install the latest trunk snapshot using the Installer app from swift.org
• Clone Swift repository

git clone git@github.com:swiftlang/swift.git

• Clone other required repositories

./swift/utils/update-checkout --clone --scheme main

• Open the Xcode version you just installed; select from the menu Xcode > Preferences > Components > Toolchains and enable the trunk snapshot you installed.
• Open Foundation.xcworkspace from the swift-corelibs-foundation repository from that version of Xcode.
• Build and run the TestFoundation scheme.

[1] Manually install CMake

• Download CMake
• Install CMake

mkdir -p $HOME/bin
tar xfz cmake-3.14.4-Darwin-x86_64.tar.gz -C $HOME/bin
export PATH=$HOME/bin/cmake-3.14.4-Darwin-x86_64/CMake.app/Contents/bin:$PATH

[2] Manually Install Sccache:

• Download sccache
• Install sccache

mkdir -p $HOME/bin
tar xfz sccache-0.2.8-x86_64-apple-darwin.tar.gz -C $HOME/bin
export PATH=$HOME/bin/sccache-0.2.8-x86_64-apple-darwin:$PATH

Good first issues

The Swift project uses GitHub Issues for tracking bugs, ideas, and tasks. For example, the issues for the Swift compiler repository can be found on its issues dashboard. Beginner-friendly issues are decorated with the good first issue label and can be found by visiting https://github.com/apple/<repository>/contribute.