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

Use experimental prefix only for old Swift versions #190

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

MaxDesiatov
Copy link
Contributor

experimental- prefix is no longer needed with Swift 6.0 and later versions, let's update README.md accordingly

`experimental-` prefix is no longer needed with Swift 6.0 and later versions, let's update `README.md` accordingly
@MaxDesiatov MaxDesiatov added the documentation Improvements or additions to documentation label Feb 26, 2025
@MaxDesiatov MaxDesiatov requested a review from euanh February 26, 2025 11:05
@MaxDesiatov
Copy link
Contributor Author

@swift-ci test

@xtremekforever
Copy link
Contributor

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 swift sdk install and swift build --swift-sdk if running on Swift 6.0 or later?

@@ -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.
Copy link
Contributor

@xtremekforever xtremekforever Feb 26, 2025

Choose a reason for hiding this comment

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

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.

@MaxDesiatov MaxDesiatov marked this pull request as draft March 7, 2025 09:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants