Skip to content

[5.9] Update Package.swift and .spi.yml to make them match #1639

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

Merged

Conversation

ahoppen
Copy link
Member

@ahoppen ahoppen commented May 4, 2023

  • Explanation: Package.swift and .spi.yml have drifted apart and didn’t actually match anymore. The targets declared in .spi.yml should match the libraries declared in the package manifest. To fix this, update .spi.yml and also declare SwiftBasicFormat as a library in Package.swift. BasicFormat is being used in sufficently many places by now that we can’t really consider it an implementation detail of SwiftSyntax anymore. This causes us to not render documentation for some targets on swiftpackageindex.com
  • Scope: How swiftpackageindex.com renders documentation + offer new library product SwiftBasicFormat
  • Risk: Basically zero, the only source change is to add a library product SwiftBasicFormat, which should be safe
  • Testing: None
  • Issue: rdar://108902357
  • Reviewer: @DougGregor on Update Package.swift and .spi.yml to make them match #1636

Package.swift and `.spi.yml` have drifted apart and didn’t actually match anymore. The targets declared in `.spi.yml` should match the libraries declared in the package manifest. To fix this, update `.spi.yml` and also declare `SwiftBasicFormat` as a library in `Package.swift`. BasicFormat is being used in sufficently many places by now that we can’t really consider it an implementation detail of SwiftSyntax anymore.

rdar://108902357
@ahoppen ahoppen requested a review from DougGregor May 4, 2023 23:44
@ahoppen
Copy link
Member Author

ahoppen commented May 4, 2023

@swift-ci Please test

@ahoppen
Copy link
Member Author

ahoppen commented May 5, 2023

@swift-ci Please test Windows

1 similar comment
@kimdv
Copy link
Contributor

kimdv commented May 5, 2023

@swift-ci Please test Windows

@ahoppen ahoppen merged commit 658efa1 into swiftlang:release/5.9 May 8, 2023
@ahoppen ahoppen deleted the ahoppen/5.9/match-documentation branch May 8, 2023 20:17
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.

3 participants