Skip to content

Commit 2a591c2

Browse files
fix(package): exclude CloudHypervisor README (#798)
## Summary Exclude `Sources/CloudHypervisor/README.md` from the `CloudHypervisor` SwiftPM target. The README remains tracked and available as source documentation, while package evaluation and builds no longer emit an unhandled-file warning. ## Motivation [#782](#782) added a standalone `CloudHypervisor` target with a README inside its source directory. SwiftPM requires non-source files in target directories to be declared as resources or excluded. This README is documentation rather than a runtime resource, so exclusion is the smallest accurate manifest change. ## Changes - Add `README.md` to the `CloudHypervisor` target's `exclude` list. - Preserve the existing README content and location. - Leave runtime code, products, resources, and package APIs unchanged. ## Validation ```sh swift package describe >/dev/null swift test --disable-automatic-resolution --filter CloudHypervisorTests make check git diff --check upstream/main...HEAD ``` - Package evaluation completes without the `Sources/CloudHypervisor/README.md` warning. - All 41 focused `CloudHypervisorTests` pass. - Swift formatting and Hawkeye license checks pass. - The committed diff has no whitespace errors. ## Compatibility And Risk This manifest-only change does not alter compiled sources, runtime resources, public APIs, or supported platforms. The README is already non-executable documentation, so excluding it accurately records SwiftPM's intended treatment of the file. ## Related - Follow-up to [#782](#782). ## Release Note Highlight - Stops SwiftPM builds from warning about the `CloudHypervisor` README added by [#782](#782).
1 parent 2f947e7 commit 2a591c2

1 file changed

Lines changed: 3 additions & 0 deletions

File tree

Package.swift

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -273,6 +273,9 @@ let package = Package(
273273
.product(name: "NIOPosix", package: "swift-nio"),
274274
.product(name: "NIOHTTP1", package: "swift-nio"),
275275
.product(name: "NIOConcurrencyHelpers", package: "swift-nio"),
276+
],
277+
exclude: [
278+
"README.md"
276279
]
277280
),
278281
.testTarget(

0 commit comments

Comments
 (0)