Update .spi.yml network documentation targets#1894
Open
anxkhn wants to merge 1 commit into
Open
Conversation
The network plugin target reorganization renamed the network targets to ContainerNetworkClient, ContainerNetworkServer, and ContainerNetworkVmnetServer. scripts/make-docs.sh was updated to match, but the Swift Package Index manifest still referenced the old ContainerNetworkService and ContainerNetworkServiceClient targets, which no longer exist in Package.swift. This left the hosted DocC build pointing at missing targets, so the network plugin documentation was not published. Point .spi.yml at the current targets so its documentation_targets list matches make-docs.sh again.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Type of Change
Motivation and Context
The network plugin target reorganization in #1615 renamed the network targets to
ContainerNetworkClient,ContainerNetworkServer, andContainerNetworkVmnetServer, and updatedscripts/make-docs.shto match. TheSwift Package Index manifest
.spi.ymlwas missed (its last update was #1577,before the reorg), so it still listed the old
ContainerNetworkServiceandContainerNetworkServiceClienttargets, which no longer exist inPackage.swift.Because Swift Package Index builds hosted DocC from
.spi.yml, the two staleentries point the build at missing targets, so the network plugin documentation
is not published. This change points
.spi.ymlat the current targets so itsdocumentation_targetslist matchesscripts/make-docs.shagain.Testing
swift package dump-packagesucceeds and every one of the 15documentation_targetsin.spi.ymlnow resolves to a real SwiftPM target (twodid not resolve before this change). The list is identical, in the same order, to
the
--targetlist inscripts/make-docs.sh, and no references to the old targetnames remain anywhere in the tree.
.spi.ymlis a hosting manifest, not compiledcode, and has no test harness, so there is no unit test to add.
The diff (for reference)