Repository navigation
Conversation
Add .spi.yml so the Swift Package Index builds and hosts the DocC documentation for the TLDExtractSwift target. Pass --include-extended-types to the DocC plugin, because part of the public API is extensions on URL and String and those symbols are dropped without it. The GitHub Pages site stays as is. Add the SPI Swift version and platform compatibility badges to the README, next to the other distribution badges. Both render as unknown until the package is accepted into the index and built for the first time.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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.
Summary
Prepares the repository for a Swift Package Index listing.
.spi.yml— has SPI build and host the DocC documentation for theTLDExtractSwifttarget.custom_documentation_parameters: [--include-extended-types]is required here: part of the public API is extensions onURLandString, and those symbols are dropped without the flag (the same reasonscripts/gen_docs.shpasses-emit-extension-block-symbols). SPI injects the Swift-DocC plugin itself, soPackage.swiftis unchanged.The existing GitHub Pages documentation site and
docs.ymlare untouched; SPI hosting is additive and gives per-version documentation, which Pages does not.Coordination
Matched with futamura/PunycodeSwift#88, which lands the same
.spi.ymlshape and badge placement.Follow-up (not in this PR)
After this and the PunycodeSwift PR are merged to
main, a single issue onSwiftPackageIndex/PackageListsubmits bothhttps://github.com/futamura/PunycodeSwift.gitandhttps://github.com/futamura/TLDExtractSwift.git. Note for that issue: the index already lists the forkMarcoEidinger/TLDExtractSwift, so the canonical repository is not a duplicate submission.Verification
.spi.ymlparses as YAML and its keys matchSPIManifest.Manifest(version,builder.configs[].documentation_targets,custom_documentation_parameters).