update[static-sdk]: expand installation section #1143
Conversation
| provided with Xcode to build programs using the SDK. Instead, just | ||
| to remind you, you must use the Swift compiler from the open-source |
There was a problem hiding this comment.
| provided with Xcode to build programs using the SDK. Instead, just | |
| to remind you, you must use the Swift compiler from the open-source | |
| provided with Xcode to build programs using the SDK. Instead, | |
| you must use the Swift compiler from the open-source |
| * For development snapshots, access the static-sdk YAML file for your | ||
| target branch (e.g., swift-6.2-branch snapshots | ||
| [here](https://github.com/swiftlang/swift-org-website/blob/main/_data/builds/swift-6_2-branch/static-sdk.yml)) | ||
| to quickly construct the install command (following the pattern | ||
| explained below) by browsing the available checksums. |
There was a problem hiding this comment.
As I mentioned elsewhere, I think directing people to work out the URL for a YAML file is less than ideal. I'm not even sure that the URLs for these files are necessarily fixed in stone, or indeed documented anywhere. @shahmishal, what do you think?
There was a problem hiding this comment.
We should point them to the installation page, and avoid hardcoding because it will get out of date.
There was a problem hiding this comment.
May I kindly request to elaborate?
We’ve already pointed to the installation page, which provides guidance on navigating past releases.
However, it appears that the development snapshots are not being published on swift.org. Could you suggest a more user-friendly method for users to retrieve the checksums, particularly for the development snapshots, so that they can more conveniently construct the installation command?
There was a problem hiding this comment.
Update: Removed this for now.
|
|
||
| ```console | ||
| $ swift sdk install https://download.swift.org/swift-6.0-branch/static-sdk/swift-6.0-DEVELOPMENT-SNAPSHOT-2024-07-02-a/swift-6.0-DEVELOPMENT-SNAPSHOT-2024-07-02-a_static-linux-0.0.1.artifactbundle.tar.gz --checksum 42a361e1a240e97e4bb3a388f2f947409011dcd3d3f20b396c28999e9736df36 | ||
| $ swift sdk install https://download.swift.org/swift-6.1.2-release/static-sdk/swift-6.1.2-RELEASE/swift-6.1.2-RELEASE_static-linux-0.0.1.artifactbundle.tar.gz --checksum df0b40b9b582598e7e3d70c82ab503fd6fbfdff71fd17e7f1ab37115a0665b3b |
There was a problem hiding this comment.
We should replace this with logic to look up the latest from https://github.com/swiftlang/swift-org-website/blob/main/_data/builds/swift_releases.yml file.
There was a problem hiding this comment.
How would you propose to do that?
There was a problem hiding this comment.
For example:
{% assign platform = site.data.builds.swift_releases.last.platforms | where: 'name', 'Static SDK'| first %}
{% assign tag = site.data.builds.swift_releases.last.tag %}
{% assign tag_downcase = site.data.builds.swift_releases.last.tag | downcase %}
{% assign base_url = "https://download.swift.org/" | append: tag_downcase | append: "/static-sdk/" | append: tag | append: "/" | append: tag %}
{% assign command = "swift sdk install " | append: base_url | append: "_static-linux-0.0.1.artifactbundle.tar.gz --checksum " | append: platform.checksum %}
{{ command }}
Signed-off-by: Melissa Kilby <[email protected]>
Co-authored-by: Alastair Houghton <[email protected]> Signed-off-by: Melissa Kilby <[email protected]>
Co-authored-by: Mishal Shah <[email protected]> Signed-off-by: Melissa Kilby <[email protected]>
incertum
force-pushed
the
update-static-sdk-installation
branch
from
d60bb11 to
b8a367c
Compare
|
Just rebased this PR, thank you. |
|
@swift-ci please test |
@shahmishal @al45tair @heckj May I kindly check in on the status of this PR? Thank you. |
| You can provide either a URL (with corresponding checksum) or a local | ||
| filename where the SDK can be found. | ||
|
|
||
| <!-- |
There was a problem hiding this comment.
Should this be commented out?
There was a problem hiding this comment.
Please let me know what the preference is.
It worked locally for me that way (building the website locally) while it was hiding the content when rendering the markdown.
4 participants
Motivation:
update[static-sdk]: expand installation section
Rearrange the Installation section and provide a slightly more detailed, step-by-step guide, while still avoiding overly detailed tangents.
CC @al45tair and @shahmishal