Document ArtifactBundleIndex usage for binary dependencies #9544
+13
−0
Conversation
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
Viditgupta-official
requested review from
bkhouri,
bripeticca,
cmcgee1024,
daveyc123,
dschaefer2,
jakepetroules,
owenv,
plemarquand and
rconnell9
as code owners
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.
Summary
This PR adds user-facing documentation for ArtifactBundleIndex in Swift Package Manager’s binary dependencies documentation.
It explains what ArtifactBundleIndex is, when it is required, and how it is used to locate artifacts within an artifact bundle.
Details
The documentation covers:
What an ArtifactBundleIndex represents
When SwiftPM expects an index to be present in an artifact bundle
How SwiftPM uses the index during dependency resolution
A reference to the Swift Evolution proposal (SE-0305) for additional background
This makes binary dependency behaviour clearer for package authors distributing artifact bundles.
Fixes #9171