Skip to content

Commit 83d5435

Browse files
committed
Add qualification status for supported platforms in the README
We've been able to build for more platforms in our CI, so update the README to reflect this triumph. Explain how the different qualification levels differ, and focus on build + test for all platforms in the future. Move some platforms from Experimental -> Supported, although not with full CI build + test yet.
1 parent b559967 commit 83d5435

File tree

1 file changed

+19
-10
lines changed

1 file changed

+19
-10
lines changed

README.md

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -106,14 +106,23 @@ Swift.
106106
The table below describes the current level of support that Swift Testing has
107107
for various platforms:
108108

109-
| **Platform** | **Support Status** |
110-
|-|-|
111-
| Apple platforms | Supported |
112-
| Linux | Supported |
113-
| Windows | Supported |
114-
| FreeBSD, OpenBSD | Experimental |
115-
| Wasm | Experimental |
116-
| Android | Experimental |
109+
| **Platform** | **Support Status** | **Qualification[^1]** |
110+
| ---------------- | ------------------ | ---------------------- |
111+
| Apple platforms | Supported | Automated |
112+
| Linux | Supported | Automated |
113+
| Windows | Supported | Automated |
114+
| Wasm | Experimental | Automated (Build Only) |
115+
| Android | Experimental | Automated (Build Only) |
116+
| FreeBSD, OpenBSD | Experimental | Manual |
117+
118+
[^1]:
119+
Most platforms have "Automated" qualification, where continuous integration
120+
automatically verifies that the project builds and passes all tests. This
121+
ensures that any changes meet our highest quality standards, so it is our
122+
goal for all supported platforms.
123+
124+
Presently, some platforms rely on manual test ("Automated (Build Only)"
125+
qualification) or manual build and test ("Manual" qualification).
117126

118127
### Works with XCTest
119128

@@ -127,7 +136,7 @@ Detailed documentation for Swift Testing can be found on the
127136
[Swift Package Index](https://swiftpackageindex.com/swiftlang/swift-testing/main/documentation/testing).
128137
There, you can delve into comprehensive guides, tutorials, and API references to
129138
make the most out of this package. Swift Testing is included with the Swift 6
130-
toolchain and Xcode 16. You do not need to add it as a package dependency to
139+
toolchain and Xcode 16. You do not need to add it as a package dependency to
131140
your Swift package or Xcode project.
132141

133142
> [!IMPORTANT]
@@ -136,5 +145,5 @@ your Swift package or Xcode project.
136145
> repository requires a recent **main-branch development snapshot** toolchain.
137146
138147
Other documentation resources for this project can be found in the
139-
[README](https://github.com/swiftlang/swift-testing/blob/main/Documentation/README.md)
148+
[README](https://github.com/swiftlang/swift-testing/blob/main/Documentation/README.md)
140149
of the `Documentation/` subdirectory.

0 commit comments

Comments
 (0)