mirror of
https://github.com/apple/swift.git
synced 2025-12-14 20:36:38 +01:00
cb3293b2e5
This PR updates the CI summary table in the README.md to summarize all architectures for a host to be on the same line with the architecture specified in the badge itself (rather than a generic "build" label), thereby enabling the whole CI status to be visible on a single page. It also adds accessibility labels to each of the CI badges for Global Accessibility Awareness Month.
157 lines
9.8 KiB
Markdown
157 lines
9.8 KiB
Markdown
<picture>
|
|
<source media="(prefers-color-scheme: dark)" srcset="https://www.swift.org/assets/images/swift~dark.svg">
|
|
<img src="https://www.swift.org/assets/images/swift.svg" alt="Swift logo" height="70">
|
|
</picture>
|
|
|
|
# Swift Programming Language
|
|
|
|
| **OS** | **Status** |
|
|
|---:|:---:|
|
|
| macOS | [](https://ci.swift.org/job/oss-swift-package-macos)|
|
|
| Ubuntu 20.04 | [](https://ci.swift.org/job/oss-swift-package-ubuntu-20_04) [](https://ci.swift.org/job/oss-swift-package-ubuntu-20_04-aarch64)|
|
|
| Ubuntu 22.04 | [](https://ci.swift.org/job/oss-swift-package-ubuntu-22_04) [](https://ci.swift.org/job/oss-swift-package-ubuntu-22_04-aarch64)|
|
|
| Ubuntu 24.04 | [](https://ci.swift.org/job/oss-swift-package-ubuntu-24_04) [](https://ci.swift.org/job/oss-swift-package-ubuntu-24_04-aarch64)|
|
|
| Amazon Linux 2 | [](https://ci.swift.org/job/oss-swift-package-amazon-linux-2) [](https://ci.swift.org/job/oss-swift-package-amazon-linux-2-aarch64)|
|
|
| Debian 12 | [](https://ci.swift.org/job/oss-swift-package-debian-12) [](https://ci.swift.org/job/oss-swift-package-debian-12-aarch64)|
|
|
| Windows 10 | [](https://ci-external.swift.org/job/swift-main-windows-toolchain) [](https://ci-external.swift.org/job/swift-main-windows-toolchain-arm64)|
|
|
| Universal Base Image 9 | [](https://ci.swift.org/job/oss-swift-package-ubi-9)|
|
|
|**Cross-Compilation Targets**||
|
|
| wasm32-unknown-wasi |[](https://ci.swift.org/job/oss-swift-pr-test-crosscompile-wasm-ubuntu-20_04)|
|
|
|**Community-Hosted CI Platforms**||
|
|
|[Android](https://github.com/swiftlang/swift-community-hosted-continuous-integration/blob/main/nodes/x86_64_ubuntu_24_04_android.json) | [](https://ci-external.swift.org/job/oss-swift-RA-linux-ubuntu-24.04-android-build) [](https://ci-external.swift.org/job/oss-swift-RA-linux-ubuntu-24.04-android-arm64)|
|
|
|
|
## Welcome to Swift
|
|
|
|
Swift is a high-performance system programming language. It has a clean
|
|
and modern syntax, offers seamless access to existing C and Objective-C code
|
|
and frameworks, and is memory-safe by default.
|
|
|
|
Although inspired by Objective-C and many other languages, Swift is not itself a
|
|
C-derived language. As a complete and independent language, Swift packages core
|
|
features like flow control, data structures, and functions, with high-level
|
|
constructs like objects, protocols, closures, and generics. Swift embraces
|
|
modules, eliminating the need for headers and the code duplication they entail.
|
|
|
|
To learn more about the programming language, visit [swift.org](https://swift.org/documentation/).
|
|
|
|
- [Contributing to Swift](#contributing-to-swift)
|
|
- [Getting Started](#getting-started)
|
|
- [Swift Toolchains](#swift-toolchains)
|
|
- [Build Failures](#build-failures)
|
|
- [Learning More](#learning-more)
|
|
|
|
## Contributing to Swift
|
|
|
|
Contributions to Swift are welcomed and encouraged! Please see the
|
|
[Contributing to Swift guide](https://swift.org/contributing/).
|
|
|
|
Before submitting the pull request, please make sure you have [tested your
|
|
changes](https://github.com/apple/swift/blob/main/docs/ContinuousIntegration.md)
|
|
and that they follow the Swift project [guidelines for contributing
|
|
code](https://swift.org/contributing/#contributing-code).
|
|
|
|
To be a truly great community, [Swift.org](https://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](https://swift.org/code-of-conduct/).
|
|
|
|
## Getting Started
|
|
|
|
If you are interested in:
|
|
- Contributing fixes and features to the compiler: See our
|
|
[How to Submit Your First Pull Request guide](/docs/HowToGuides/FirstPullRequest.md).
|
|
- Building the compiler as a one-off: See our [Getting Started guide][].
|
|
- Building a toolchain as a one-off: Follow the [Getting Started guide][]
|
|
up until the "Building the project" section. After that, follow the
|
|
instructions in the [Swift Toolchains](#swift-toolchains) section below.
|
|
|
|
We also have an [FAQ](/docs/HowToGuides/FAQ.md) that answers common questions.
|
|
|
|
[Getting Started guide]: /docs/HowToGuides/GettingStarted.md
|
|
|
|
### Swift Toolchains
|
|
|
|
#### Building
|
|
|
|
Swift toolchains are created using the script
|
|
[build-toolchain](https://github.com/apple/swift/blob/main/utils/build-toolchain). This
|
|
script is used by swift.org's CI to produce snapshots and can allow for one to
|
|
locally reproduce such builds for development or distribution purposes. A typical
|
|
invocation looks like the following:
|
|
|
|
```sh
|
|
$ ./swift/utils/build-toolchain $BUNDLE_PREFIX
|
|
```
|
|
|
|
where ``$BUNDLE_PREFIX`` is a string that will be prepended to the build
|
|
date to give the bundle identifier of the toolchain's ``Info.plist``. For
|
|
instance, if ``$BUNDLE_PREFIX`` was ``com.example``, the toolchain
|
|
produced will have the bundle identifier ``com.example.YYYYMMDD``. It
|
|
will be created in the directory you run the script with a filename
|
|
of the form: ``swift-LOCAL-YYYY-MM-DD-a-osx.tar.gz``.
|
|
|
|
Beyond building the toolchain, ``build-toolchain`` also supports the
|
|
following (non-exhaustive) set of useful options:
|
|
|
|
- ``--dry-run``: Perform a dry run build. This is off by default.
|
|
- ``--test``: Test the toolchain after it has been compiled. This is off by default.
|
|
- ``--distcc``: Use distcc to speed up the build by distributing the C++ part of
|
|
the swift build. This is off by default.
|
|
- ``--sccache``: Use sccache to speed up subsequent builds of the compiler by
|
|
caching more C++ build artifacts. This is off by default.
|
|
|
|
More options may be added over time. Please pass ``--help`` to
|
|
``build-toolchain`` to see the full set of options.
|
|
|
|
#### Installing into Xcode
|
|
|
|
On macOS if one wants to install such a toolchain into Xcode:
|
|
|
|
1. Untar and copy the toolchain to one of `/Library/Developer/Toolchains/` or
|
|
`~/Library/Developer/Toolchains/`. E.g.:
|
|
|
|
```sh
|
|
$ sudo tar -xzf swift-LOCAL-YYYY-MM-DD-a-osx.tar.gz -C /
|
|
$ tar -xzf swift-LOCAL-YYYY-MM-DD-a-osx.tar.gz -C ~/
|
|
```
|
|
|
|
The script also generates an archive containing debug symbols which
|
|
can be installed over the main archive allowing symbolication of any
|
|
compiler crashes.
|
|
|
|
```sh
|
|
$ sudo tar -xzf swift-LOCAL-YYYY-MM-DD-a-osx-symbols.tar.gz -C /
|
|
$ tar -xzf swift-LOCAL-YYYY-MM-DD-a-osx-symbols.tar.gz -C ~/
|
|
```
|
|
|
|
2. Specify the local toolchain for Xcode's use via `Xcode->Toolchains`.
|
|
|
|
### Build Failures
|
|
|
|
Try the suggestions in
|
|
[Troubleshooting build issues](/docs/HowToGuides/GettingStarted.md#troubleshooting-build-issues).
|
|
|
|
Make sure you are using the
|
|
[correct release](/docs/HowToGuides/GettingStarted.md#installing-dependencies)
|
|
of Xcode.
|
|
|
|
If you have changed Xcode versions but still encounter errors that appear to
|
|
be related to the Xcode version, try passing `--clean` to `build-script`.
|
|
|
|
When a new version of Xcode is released, you can update your build without
|
|
recompiling the entire project by passing `--reconfigure` to `build-script`.
|
|
|
|
## Learning More
|
|
|
|
Be sure to look at the [documentation index](/docs/README.md) for a bird's eye
|
|
view of the available documentation. In particular, the documents titled
|
|
[Debugging the Swift Compiler](docs/DebuggingTheCompiler.md) and
|
|
[Continuous Integration for Swift](docs/ContinuousIntegration.md) are very
|
|
helpful to understand before submitting your first PR.
|