Move platform requirements to availability annotations #348
+225
−13
Conversation
This file contains 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
Adding or raising the deployment platforms in the package manifest is a SemVer major breaking change as consumers must also add or raise their deployment platforms. This is a known limitation of SwiftPM. Unforunately this means that it's very difficult for non-leaf packages to adopt packages which declare their platforms in the manifest. Doing so puts the brakes on adoption and ecosystem growth. For 'core' packages like this one availability constraints should be expressed on declarations rather than in the manifest. This patch adds equivalent availability annotations to declarations across the package and removes platforms from the package manifest.
|
@phausler note that Swift 5.6 and Swift 5.7 still use |
phausler
reviewed
Apr 15, 2025
Package.swift
Outdated
| // Availability Macro Utilities | ||
| enum _OSAvailability: String { | ||
| // This should match the package's deployment target | ||
| case alwaysAvailable = "macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0" |
There was a problem hiding this comment.
naming nit: this should probably be more so named initialIntroduction and not the "alwaysAvailable" since this is not something that has always been around.
| case alwaysAvailable = "macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0" | ||
| // Use 10000 for future availability to avoid compiler magic around | ||
| // the 9999 version number but ensure it is greater than 9999 | ||
| case future = "macOS 10000, iOS 10000, tvOS 10000, watchOS 10000" |
There was a problem hiding this comment.
it might be good to have a "pending" case for the 9999 versions
Package.swift
Outdated
| let versionNumbers = ["1.0"] | ||
|
|
||
| // Availability Macro Utilities | ||
| enum _OSAvailability: String { |
There was a problem hiding this comment.
naming nit: this doesn't need an underscore since this is not public API (it is restricted to the package)
There was a problem hiding this comment.
ack, this was copy-pasta from Foundation. I've fixed this up now.
Package.swift
Outdated
| case future = "macOS 10000, iOS 10000, tvOS 10000, watchOS 10000" | ||
| } | ||
|
|
||
| struct _Availability { |
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.
Adding or raising the deployment platforms in the package manifest is a SemVer major breaking change as consumers must also add or raise their deployment platforms. This is a known limitation of SwiftPM.
Unforunately this means that it's very difficult for non-leaf packages to adopt packages which declare their platforms in the manifest. Doing so puts the brakes on adoption and ecosystem growth. For 'core' packages like this one availability constraints should be expressed on declarations rather than in the manifest.
This patch adds equivalent availability annotations to declarations across the package and removes platforms from the package manifest.