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 'current version' instead of specific Xcode version #495

Merged
merged 2 commits into from
Jan 26, 2024

Conversation

dempseyatgithub
Copy link
Contributor

The Xcode version is read from the last entry of swift_releases.yml. Multiple Xcode versions can ship with the same Swift version, so the Xcode version displayed can be out of date.

The exact Xcode version is not very important to display on the page. So, instead of creating and maintaining an Xcode version data file, the text changes to say 'current version'.

Since the user will clicking through to the Mac App Store, they will see the correct version number on the app page in the store.

This fixes #493.

The Xcode version is read from the last entry of swift_releases.yml.
Multiple Xcode versions can ship with the same Swift version, so
the Xcode version displayed can be out of date.

The exact Xcode version is not very important to display on the page.
So, instead of creating and maintaining an Xcode version data file,
the text changes to say 'current version'.

Since the user will clicking through to the Mac App Store, they will
see the correct version number on the app page in the store.

This fixes swiftlang#493.
Copy link
Member

@kaishin kaishin left a comment

Choose a reason for hiding this comment

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

+1 from me

@dempseyatgithub
Copy link
Contributor Author

Note I also made the change to the macOS install page where a similar thing could happen.

Will defer merging to give @shahmishal a chance to take a look.

@dempseyatgithub
Copy link
Contributor Author

@swift-ci test please

@dempseyatgithub
Copy link
Contributor Author

@swift-ci test

Copy link
Member

@alexandersandberg alexandersandberg left a comment

Choose a reason for hiding this comment

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

If the xcode values are inaccurate we should probably remove them from the data file as well.

@@ -4,7 +4,7 @@
<li class="resource featured">
<h3>Xcode</h3>
<p class="description">
Download {{ site.data.builds.swift_releases.last.xcode }} which contains the latest Swift release.
Copy link
Member

@shahmishal shahmishal Jan 25, 2024

Choose a reason for hiding this comment

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

What about Download {{ site.data.builds.swift_releases.last.xcode }} or later contains the latest Swift release

In this example: Xcode 15.1 and 15.2 both have same swift compiler, so we would cover the case where we don't release a newer swift compiler version with a Xcode release.

Copy link
Contributor Author

@dempseyatgithub dempseyatgithub Jan 25, 2024

Choose a reason for hiding this comment

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

@shahmishal Do you mean update the data file 'Xcode' field to 15.2?

Copy link
Member

Choose a reason for hiding this comment

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

We can keep it to Xcode 15.1, however the text would be

Download {{ site.data.builds.swift_releases.last.xcode }} or later contains the latest Swift release

output:
Download Xcode 15.1 or later contains the latest Swift release

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thank you for clarifying, I missed the 'or later' in your original post.

So the choice would be between:

"Download Xcode 15.1 or later which contains the latest Swift release."

"Download the current version of Xcode which contains the latest Swift release."

In both cases, the user doesn't know exactly which version of Xcode they are going to get when they click on the link to the Mac App Store.

I think the more general 'current version' reads better and also gives the user a better conceptual idea of what they are doing.

It's probably less important to someone new to Swift what the exact version of Xcode is that they have to download. But probably more important that they are getting the current version of Xcode to get the latest version of Swift.

Copy link
Member

Choose a reason for hiding this comment

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

Good point, I am ok with using current compared to specific Xcode version.

@dempseyatgithub
Copy link
Contributor Author

If the xcode values are inaccurate we should probably remove them from the data file as well.

The values represent the first version of Xcode that version of Swift appeared in, so they are accurate.

Potentially the xcode value could be an array of Xcode versions.

But, it seemed like adding the ongoing maintenance of tracking and updating the file for minor and patch releases of Xcode without new versions of Swift was high compared the minimal benefit of using the correct version number in two descriptive strings on the site.

@dempseyatgithub dempseyatgithub merged commit 47c5a9c into swiftlang:main Jan 26, 2024
1 check passed
@dempseyatgithub dempseyatgithub deleted the fix-issue-493 branch January 26, 2024 00:38
@dempseyatgithub dempseyatgithub self-assigned this Jan 31, 2024
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.

Install page references outdated Xcode version as latest
4 participants