Skip to content

Conversation

grynspan
Copy link
Contributor

@grynspan grynspan commented Sep 19, 2025

This PR explicitly marks the image attachments API bits in the core Swift Testing library as unavailable on e.g. Linux. Developers who attempt to use this API on Linux will get diagnostics such as:

🛑 'AttachableImageFormat' is unavailable: Image attachments are not available on this platform.

Blocked on #1329.

Checklist:

  • Code and documentation should follow the style of the Style Guide.
  • If public symbols are renamed or modified, DocC references should be updated.

@grynspan grynspan added this to the Swift 6.x (main) milestone Sep 19, 2025
@grynspan grynspan self-assigned this Sep 19, 2025
@grynspan grynspan added enhancement New feature or request linux 🐧 Linux support (all distros) embedded-swift 📟 Embedded Swift issues wasi/wasm 🧭 WebAssembly support android 🤖 Android support freebsd 😈 FreeBSD support attachments/activities 🖇️ Work related to attachments and/or activities qnx 🫐 QNX support playstation 🎮 PS4/PS5 support openbsd 🐡 OpenBSD support image-attachments 📸 Work related to image attachments labels Sep 19, 2025
@grynspan grynspan force-pushed the jgrynspan/mark-image-attachments-unavailable-on-other-platforms branch from 8a39992 to f3b39b9 Compare September 19, 2025 21:11
This PR explicitly marks the image attachments API bits in the core Swift
Testing library as unavailable on e.g. Linux. Developers who attempt to use this
API on Linux will get diagnostics such as:

> 🛑 'AttachableImageFormat' is unavailable: Image attachments are not available on this platform.
@grynspan grynspan force-pushed the jgrynspan/mark-image-attachments-unavailable-on-other-platforms branch from e5cc7c6 to 8503f6c Compare September 22, 2025 22:08
@grynspan grynspan marked this pull request as ready for review September 22, 2025 22:09
Copy link
Contributor

@stmontgomery stmontgomery left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you do end up landing this with the CI change to disable Docs soundness checks, please either file an issue tracking re-enabling them at some point when we can identify a viable workaround or ping me to do that. One remaining idea I had was to switch that CI job to macOS instead of Linux.

@grynspan
Copy link
Contributor Author

Filed swiftlang/github-workflows#166

@grynspan grynspan merged commit 894fc62 into main Sep 23, 2025
47 of 48 checks passed
@grynspan grynspan deleted the jgrynspan/mark-image-attachments-unavailable-on-other-platforms branch September 23, 2025 16:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
android 🤖 Android support attachments/activities 🖇️ Work related to attachments and/or activities embedded-swift 📟 Embedded Swift issues enhancement New feature or request freebsd 😈 FreeBSD support image-attachments 📸 Work related to image attachments linux 🐧 Linux support (all distros) openbsd 🐡 OpenBSD support playstation 🎮 PS4/PS5 support qnx 🫐 QNX support wasi/wasm 🧭 WebAssembly support
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants