Skip to content

Commit fa1e095

Browse files
authored
Adjust README to show status badges from GitHub Actions workflows (#1364)
This adjusts `README.md` to begin showing CI status badges from the GitHub Actions workflows I configured in #1361. View [rendered README document](https://github.com/stmontgomery/swift-testing/blob/github-actions-badges/README.md). ### Motivation: This will help ensure our CI status badges remain consistent with the CI status shown on Pull Requests. ### Modifications: - Remove the CI status column on the "Supported platforms" table from the README. - This is because the new workflows do not offer granular, per-platform status badges (see [GitHub's documentation](https://docs.github.com/en/actions/how-tos/monitor-workflows/add-a-status-badge)). - Add a new section to the README showing this status. - Drive-by improvement: Move "Windows" platform up a few rows so that all the Supported platforms are listed first, followed by all Experimental platforms. ### Checklist: - [x] Code and documentation should follow the style of the [Style Guide](https://github.com/apple/swift-testing/blob/main/Documentation/StyleGuide.md). - [x] If public symbols are renamed or modified, DocC references should be updated.
1 parent 08f39d6 commit fa1e095

File tree

1 file changed

+11
-12
lines changed

1 file changed

+11
-12
lines changed

README.md

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,9 @@ See https://swift.org/CONTRIBUTORS.txt for Swift project authors
1313
Swift Testing is a package with expressive and intuitive APIs that make testing
1414
your Swift code a breeze.
1515

16+
[![CI status badge for main branch using main toolchain](https://github.com/swiftlang/swift-testing/actions/workflows/main_using_main.yml/badge.svg?branch=main&event=push)](https://github.com/swiftlang/swift-testing/actions/workflows/main_using_main.yml)
17+
[![CI status badge for main branch using 6.2 toolchain](https://github.com/swiftlang/swift-testing/actions/workflows/main_using_release.yml/badge.svg?branch=main&event=push)](https://github.com/swiftlang/swift-testing/actions/workflows/main_using_release.yml)
18+
1619
## Feature overview
1720

1821
### Clear, expressive API
@@ -103,18 +106,14 @@ Swift.
103106
The table below describes the current level of support that Swift Testing has
104107
for various platforms:
105108

106-
| **Platform** | **CI Status (6.2)** | **CI Status (main)** | **Support Status** |
107-
|---|:-:|:-:|---|
108-
| **macOS** | [![Build Status](https://ci.swift.org/buildStatus/icon?job=swift-testing-main-swift-6.2-macos)](https://ci.swift.org/job/swift-testing-main-swift-6.2-macos/) | [![Build Status](https://ci.swift.org/buildStatus/icon?job=swift-testing-main-swift-main-macos)](https://ci.swift.org/view/Swift%20Packages/job/swift-testing-main-swift-main-macos/) | Supported |
109-
| **iOS** | | | Supported |
110-
| **watchOS** | | | Supported |
111-
| **tvOS** | | | Supported |
112-
| **visionOS** | | | Supported |
113-
| **Ubuntu 22.04** | [![Build Status](https://ci.swift.org/buildStatus/icon?job=swift-testing-main-swift-6.2-linux)](https://ci.swift.org/job/swift-testing-main-swift-6.2-linux/) | [![Build Status](https://ci.swift.org/buildStatus/icon?job=swift-testing-main-swift-main-linux)](https://ci.swift.org/view/Swift%20Packages/job/swift-testing-main-swift-main-linux/) | Supported |
114-
| **FreeBSD** | | | Experimental |
115-
| **OpenBSD** | | | Experimental |
116-
| **Windows** | [![Build Status](https://ci-external.swift.org/buildStatus/icon?job=swift-testing-main-swift-6.2-windows)](https://ci-external.swift.org/view/all/job/swift-testing-main-swift-6.2-windows/) | [![Build Status](https://ci-external.swift.org/buildStatus/icon?job=swift-testing-main-swift-main-windows)](https://ci-external.swift.org/job/swift-testing-main-swift-main-windows/) | Supported |
117-
| **Wasm** | | | Experimental |
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 |
118117

119118
### Works with XCTest
120119

0 commit comments

Comments
 (0)