Use experimental prefix only for old Swift versions
#190
Conversation
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
`experimental-` prefix is no longer needed with Swift 6.0 and later versions, let's update `README.md` accordingly
|
@swift-ci test |
|
There is also the message that is printed when the Swift SDK is generated (here): print(
"""
All done! Install the newly generated SDK with this command:
swift experimental-sdk install \(pathsConfiguration.artifactBundlePath)
After that, use the newly installed SDK when building with this command:
swift build --experimental-swift-sdk \(artifactID)
"""
)Should this also be changed to use |
| @@ -169,7 +182,7 @@ swift run swift-sdk-generator make-linux-sdk --with-docker --from-container-imag | |||
| ## Swift SDK distribution | |||
|
|
|||
| The `.artifactbundle` directory produced in the previous section can be packaged as a `.tar.gz` archive and redistributed | |||
| in this form. Users of such Swift SDK bundle archive can easily install it with `swift experimental-sdk install` | |||
| in this form. Users of such Swift SDK bundle archive can easily install it with `swift sdk install` | |||
| command, which supports both local file system paths and public `http://` and `https://` URLs as an argument. | |||
There was a problem hiding this comment.
I wonder if there should also be information about generating a checksum for the package. If you try installing a Swift SDK from a remote URL, swiftpm wants you to pass a checksum. For example:
$ swift sdk install https://download.swift.org/swift-6.0.3-release/static-sdk/swift-6.0.3-RELEASE/swift-6.0.3-RELEASE_static-linux-0.0.1.artifactbundle.tar.gz
Error: Bundles installed from remote URLs (`https://download.swift.org/swift-6.0.3-release/static-sdk/swift-6.0.3-RELEASE/swift-6.0.3-RELEASE_static-linux-0.0.1.artifactbundle.tar.gz`) require their checksum passed via `--checksum` option.
The distributor of the bundle must compute it with the `swift package compute-checksum` command and provide it with their Swift SDK installation instructions.
euanh
approved these changes
Feb 26, 2025
xtremekforever
approved these changes
Mar 7, 2025
- Merge from `main`, probably a good idea to start with.
- Only add `experimental-` prefix to success message when running under
Swift 5.x. Under 6.0 and later, you'll just get the correct message
based on your Swift version:
```
All done! Install the newly generated SDK with this command:
swift sdk install
/home/xtremek/Programming/xtremekforever/swift-sdk-generator/Bundles/6.1-
RELEASE_ubuntu_jammy_x86_64.artifactbundle
After that, use the newly installed SDK when building with this command:
swift build --swift-sdk 6.1-RELEASE_ubuntu_jammy_x86_64
```
- Added more info to the `Swift SDK Distribution` section of the README
on how to generate checksums.
Let me know what you think, maybe some good inclusions or could use some
tweaks.
---------
Co-authored-by: Mishal Shah <[email protected]>
Co-authored-by: Euan Harris <[email protected]>
Co-authored-by: Max Desiatov <[email protected]>
Co-authored-by: xavgru12 <[email protected]>
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.
experimental-prefix is no longer needed with Swift 6.0 and later versions, let's updateREADME.mdaccordingly