docs(readme): add Swift Package Index compatibility badges#49
Conversation
The package was added to swiftpackageindex.com/youtalk/swift-ros2 via PackageList PR #13355. SPI now publishes dynamic compatibility badges derived from its build matrix: - swift-versions: 6.3 | 6.2 | 6.1 | 6.0 - platforms: iOS | macOS | visionOS Both link back to the SPI package page so readers can drill into the full per-platform / per-Swift status and the generated DocC documentation.
There was a problem hiding this comment.
Pull request overview
Adds Swift Package Index (SPI) compatibility badges to the README so readers can quickly see supported Swift versions and platforms, with links to the SPI package page.
Changes:
- Add SPI dynamic badge for Swift version compatibility.
- Add SPI dynamic badge for platform compatibility.
- Link both badges to the SPI package page for drill-down details and DocC.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| [](https://swift.org) | ||
| [](https://docs.ros.org) | ||
| [](LICENSE) | ||
| [](https://swiftpackageindex.com/youtalk/swift-ros2) | ||
| [](https://swiftpackageindex.com/youtalk/swift-ros2) |
There was a problem hiding this comment.
The README now shows two Swift compatibility indicators with different version sets: the static Swift badge lists 5.9 | 6.0 | 6.3, while the new SPI badge will report the SPI-tested versions (per PR description: 6.0–6.3, including 6.1/6.2). This is confusing for readers; consider updating or removing the static Swift badge so the Swift version story is consistent with SPI/CI.
There was a problem hiding this comment.
Good point — dropped the static 5.9 | 6.0 | 6.3 badge in 48489ab. SPI's dynamic badge (currently 6.3 | 6.2 | 6.1 | 6.0) is now the single source of truth for Swift compatibility, and the minimum version stays declared in Package.swift's swift-tools-version: 5.9 for anyone who needs to look it up.
Address PR review (Copilot, #49): the static Swift badge listed \`5.9 | 6.0 | 6.3\` while the SPI dynamic swift-versions badge shows the actually-tested set \`6.0 | 6.1 | 6.2 | 6.3\`. Two badges with different version sets is more confusing than informative. Drop the static badge and let SPI be the canonical source of Swift compatibility — it auto-updates as the SPI matrix evolves and links back to the per-version build status. Minimum Swift remains declared in Package.swift (\`swift-tools-version: 5.9\`) for anyone who needs it.
Summary
Current SPI matrix output:
Test plan