A high-level build system based on llbuild, used by Xcode, Swift Playground, and the Swift Package Manager
Swift Build is a high-level build system based on llbuild with great support for building Swift. It is used by Xcode to build Xcode projects and Swift packages, and by Swift Playground. It can also be used as the Swift Package Manager build system in preview form when passing --build-system swiftbuild.
When building SwiftPM from sources which include Swift Build integration, passing --build-system swiftbuild will enable the new build-system. This functionality is not currently available in nightly toolchains.
Changes to swift-build can also be tested in Xcode using the launch-xcode command plugin provided by the package. Run swift package --disable-sandbox launch-xcode from your checkout of swift-build to launch a copy of the currently xcode-selected Xcode.app configured to use your modified copy of the build system service. This workflow is currently supported when using Xcode 16.2.
Changes to swift-build can also be tested in xcodebuild using the run-xcodebuild command plugin provided by the package. Run swift package --disable-sandbox run-xcodebuild from your checkout of swift-build to run xcodebuild from the currently xcode-selected Xcode.app configured to use your modified copy of the build system service. Arguments followed by -- will be forwarded to xcodebuild unmodified. This workflow is currently supported when using Xcode 16.2.
SwiftBuild.docc contains additional technical documentation.
To view the documentation in browser, run the following command at the root of the project:
docc preview SwiftBuild.docc
On macOS, use:
xcrun docc preview SwiftBuild.docc
Before submitting the pull request, please make sure you have tested your changes. You can run the full test suite by running swift test from the root of the repository. The test suite is organized into a number of different test targets, with each corresponding to a specific component. For example, SWBTaskConstructionTests contains tests for the SWBTaskConstruction module which plan builds and then inspect the resulting build graph. Many tests in Swift Build operate on test project model objects which emulate those constructed by a higher level client and validate behavior at different layers. You can learn more about how these tests are written and organized in Project Tests.
Contributions to Swift Build are welcomed and encouraged! Please see the
Contributing to Swift guide.
Before submitting the pull request, please make sure that they follow the Swift project guidelines for contributing
code. Bug reports should be
filed in the issue tracker of
swift-build repository on GitHub.
To be a truly great community, Swift.org needs to welcome
developers from all walks of life, with different backgrounds, and with a wide
range of experience. A diverse and friendly community will have more great
ideas, more unique perspectives, and produce more great code. We will work
diligently to make the Swift community welcoming to everyone.
To give clarity of what is expected of our members, Swift has adopted the
code of conduct defined by the Contributor Covenant. This document is used
across many open source communities, and we think it articulates our values
well. For more, see the Code of Conduct.
See https://swift.org/LICENSE.txt for license information.