Skip to content

Conversation

@stmontgomery
Copy link
Contributor

This adds a new documentation article within the top-level Documentation/ directory describing the various ways Swift Testing is distributed and offers the specific recommendation that most users prefer using a built-in copy instead of a package dependency.

View the rendered document for more details.

Note: In this PR the new article is only being placed in the Documentation/ directory. I chose to place it there, initially, and not within the project's official DocC documentation catalog, but that could potentially happen in the future.

Motivation:

We have been casually giving users the recommendation to prefer built-in copies of the Testing module for a while in settings like the Swift forums, bug reports, and informal chats. But thus far, we have not collected and formally documented the reasons why using a package copy can encounter issues. This discussion recently came up during a discussion about whether to adopt Swift Testing in a test-helper library in SwiftSyntax.

My hope is that adding this document will help clarify expectations around the level of support we offer for the two distribution styles for Swift Testing.

Checklist:

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

@stmontgomery stmontgomery added this to the Swift 6.3.0 milestone Dec 16, 2025
@stmontgomery stmontgomery self-assigned this Dec 16, 2025
@stmontgomery stmontgomery added documentation 📚 Improvements or additions to documentation enhancement New feature or request interoperability ↔️ Work related to Swift Testing and XCTest interoperability labels Dec 16, 2025
Copy link
Member

@heckj heckj left a comment

Choose a reason for hiding this comment

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

spotted a couple of typos

Fix a couple typos

Co-authored-by: Joseph Heck <j_heck@apple.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation 📚 Improvements or additions to documentation enhancement New feature or request interoperability ↔️ Work related to Swift Testing and XCTest interoperability

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants