Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Set the scheme for the documentation build #65

Merged
merged 1 commit into from
Dec 14, 2023
Merged

Set the scheme for the documentation build #65

merged 1 commit into from
Dec 14, 2023

Conversation

paulb777
Copy link
Collaborator

Description of the change

If there's one library the scheme matches the package, otherwise it auto-generates one for the package and generates a scheme for each product

Motivation

Fix failing spi doc build: https://swiftpackageindex.com/builds/FDA7B1D2-9174-4546-938F-30058E60E466

Type of change

Choose one: Bug fix

@paulb777 paulb777 requested a review from andrewheard December 14, 2023 17:17
Copy link
Collaborator

@andrewheard andrewheard left a comment

Choose a reason for hiding this comment

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

I'm fine with giving this a try since it's already not working but I am skeptical that it will fix it because:

swift package \
  --allow-writing-to-directory docc \
  generate-documentation \
  --target generative-ai-swift \
  --disable-indexing \
  --transform-for-static-hosting \
  --output-path docc
Building for debugging...
Build complete! (0.67s)
error: no target named 'generative-ai-swift'

@paulb777
Copy link
Collaborator Author

spi is using a command like this though:

 xcrun xcodebuild -IDEClonedSourcePackagesDirPathOverride=$PWD/checkout/.dependencies -skipMacroValidation  docbuild OTHER_DOCC_FLAGS=--emit-digest   -scheme generative-ai-swift -destination generic/platform=tvos

and that now succeeds for me locally

@paulb777 paulb777 merged commit af1d842 into main Dec 14, 2023
8 checks passed
@paulb777 paulb777 deleted the pb-spi-docs branch December 14, 2023 17:24
@andrewheard
Copy link
Collaborator

spi is using a command like this though:

 xcrun xcodebuild -IDEClonedSourcePackagesDirPathOverride=$PWD/checkout/.dependencies -skipMacroValidation  docbuild OTHER_DOCC_FLAGS=--emit-digest   -scheme generative-ai-swift -destination generic/platform=tvos

and that now succeeds for me locally

🤞 Maybe documentation_targets in the SPI Manifest really means schemes?

@andrewheard
Copy link
Collaborator

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants