Skip to content

Conversation

heckj
Copy link
Contributor

@heckj heckj commented Sep 23, 2025

adds in docc-plugin package when attempting to build docs for Swift Package Index

@czechboy0 czechboy0 added the semver/none No version bump required. label Sep 23, 2025
@czechboy0 czechboy0 enabled auto-merge (squash) September 23, 2025 21:54
@czechboy0 czechboy0 merged commit 9aca76f into apple:main Sep 23, 2025
24 of 25 checks passed
Copy link
Member

@FranzBusch FranzBusch left a comment

Choose a reason for hiding this comment

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

It actually doesn't. SPI is automatically adding this plugin

@finestructure
Copy link

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.

@finestructure
Copy link

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

@FranzBusch
Copy link
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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
semver/none No version bump required.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants