Skip to content

Update README to reflect Swift version 6.0.3 and testing library changes #821

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.

Sign up for GitHub

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

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Update README to reflect Swift version 6.0.3 and testing library changes #821

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
53133db
Update README to reflect Swift version 6.0.3 and testing library changes
meatball133 Jan 2, 2025
044d785
update readme to say 6.1
meatball133 Apr 11, 2025
15758c0
Update README.md
meatball133 Apr 21, 2025
91227b7
Update description
meatball133 Apr 21, 2025
3ea0ebb
Update license
meatball133 Apr 22, 2025
5e3b212
Add missing link
meatball133 Apr 22, 2025
cf0fc37
Update licensing
meatball133 Apr 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 10 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@


                          [![Discourse topics](https://img.shields.io/discourse/topics?color=8A08E6&label=Connect%20&labelColor=FFDF58&logo=Discourse&logoColor=8A08E6&server=https%3A%2F%2Fforum.exercism.org&style=social)](https://forum.exercism.org)
 [![Exercism_II](https://img.shields.io/badge/Exercism--Built-9101FF?logo=swift&logoColor=F05138&labelColor=ffffff&label=Swift%205.8.1%20Powered)](https://exercism.org)
 [![Exercism_II](https://img.shields.io/badge/Exercism--Built-9101FF?logo=swift&logoColor=F05138&labelColor=ffffff&label=Swift%206.1%20Powered)](https://exercism.org)
 [![Exercism_III](https://img.shields.io/badge/Open-11b30e?labelColor=3D454D&label=Contributions)](https://exercism.org/blog/freeing-our-maintainers)  [![Build Status](https://github.com/exercism/Swift/workflows/CI/badge.svg)](https://github.com/exercism/swift/actions/workflows/ci.yml)

<br>
Expand All @@ -17,8 +17,12 @@ Hi. &nbsp;👋🏽 &nbsp;👋 &nbsp;**We are happy you are here.**&nbsp; 🎉&nb
**`exercism/Swift`** is one of many programming language tracks on [exercism(dot)org][exercism-website].
This repo holds all the instructions, tests, code, & support files for Swift _exercises_ currently under development or implemented & available for students.

🌟 &nbsp;&nbsp;Track tooling (_test-runner and Continuous Integration_) runs on Swift `5.8.1`. <br>
Copy link
Member

Choose a reason for hiding this comment

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

Why are you inserting &nbsp in markdown?

Copy link
Member

Choose a reason for hiding this comment

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

The README appears to be an adaptation of the Python track readme. The &nbsp usage comes from there. https://github.com/exercism/python/blob/9b7a74b59eb82a65d926532f4590af3eb6861c30/README.md?plain=1#L39

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes

🌟 &nbsp;&nbsp;Most exercises are solvable with Swift `5.3.0` or higher.
🌟 &nbsp;&nbsp;Track tooling (_test-runner and Continuous Integration_) runs on Swift `6.1.0`. <br>
🌟 &nbsp;&nbsp;Most exercises are solvable with Swift `6.0.0` or higher.

Currently, the track uses the new [swift-testing][swift-testing] library, requiring Swift 6.0.0 or higher to run the tests.
If you wish to still run the tests with the old XCTest framework, you can do so by pulling the `5.x` branch.
Copy link
Member

Choose a reason for hiding this comment

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

Students can work locally with the old tests, but can they submit their code to the site? The track would run the Swift 6.0 tests so would that break tests on submission? Some more detail here could be useful.

Copy link
Member Author

Choose a reason for hiding this comment

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

Not really. Most earlier solutions will still work. I think around 5-10% of the exercises have changed test cases, and those will not exist on the 5.x changes so those will likely not work.

**Note:** The `5.x` branch is no longer maintained and will not receive any updates and the solutions uploaded to the website may not work with the old XCTest framework.

This track is made up of **Practice Exercises**. Practice exercises are open-ended, and can be used to practice concepts learned, try out new techniques, and play.

Expand Down Expand Up @@ -65,7 +69,7 @@ Please keep in mind [Chesterton's Fence][chestertons-fence].

## Swift Software and Documentation

**Copyright © 2023 Apple Inc. All rights reserved.**
The Swift logo is a trademark of Apple Inc.

Swift software and documentation are licensed under the [Apache License v2.0][swift-license].

Expand All @@ -81,7 +85,8 @@ Thanks to Bethany for the allowing us to use her [template][exercism-template] f
[chestertons-fence]: https://github.com/exercism/docs/blob/main/community/good-member/chestertons-fence.md
[concept-exercises]: https://github.com/exercism/docs/blob/main/building/tracks/concept-exercises.md
[config-json]: https://github.com/exercism/swift/blob/main/config.json
[swift-license]: https://github.com/apple/swift/blob/main/LICENSE.txt
[swift-license]: https://github.com/swiftlang/swift/blob/main/LICENSE.txt
[swift-testing]: https://github.com/swiftlang/swift-testing
[good-first-issues]: https://github.com/exercism/swift/labels/good%20first%20patch
[exercise-presentation]: https://github.com/exercism/docs/blob/main/building/tracks/presentation.md
[exercism-admins]: https://github.com/exercism/docs/blob/main/community/administrators.md
Expand Down