SPI needs the docc-plugin installed to build the docs - this fixes that scenario#1
Merged
czechboy0 merged 1 commit intoapple:mainfrom Sep 23, 2025
Merged
Conversation
czechboy0
approved these changes
Sep 23, 2025
FranzBusch
reviewed
Sep 24, 2025
Member
FranzBusch
left a comment
There was a problem hiding this comment.
It actually doesn't. SPI is automatically adding this plugin
|
We do, yes! We do check for the plugin url before adding it and don't add it if we see one (it's just a grep, nothing sophisticated 😅), so make sure you don't have in there behind a conditional or something. |
|
Essentially, we're running shopt -s nullglob && for manifest in Package.swift Package@*.swift ; do
if ! grep -E -i "https://github.com/(apple|swiftlang)/swift-docc-plugin" "$manifest" ; then
cat <<EOF >> "$manifest"
package.dependencies.append(
.package(url: "https://github.com/swiftlang/swift-docc-plugin", from: "1.0.0")
)
EOF
fi
done |
Member
|
Ah I see so we need to add it ourselves. I thought you were dumping the package info and looking at the JSON output. |
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
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.
adds in docc-plugin package when attempting to build docs for Swift Package Index