Add Xcode 14.3 / Swift 5.8

[finestructure]

Add a new Swift version (major or minor)

This guide assumes that an older Swift version is removed when adding a new one. This makes the process less cumbersome, because updating the test expectations in the Server package (of which there are a number) is easier if one just shuffles Swift version numbers around without having to add and remove versions separately.

Update SPIManifest

Preconditions: None.

This can be done at any time. It only takes effect once the adopting packages (Server and Builder) update to this version.

• Update SPIManifest
• Tag new release

Example change: https://github.com/SwiftPackageIndex/SPIManifest/pull/28/files

Update setup-swift GH action

Preconditions: Swift 5.8 available (Xcode and Ubuntu release)

• Update setup-swift GH action
• Rebase to latest upstream changes
• Upstream the change Add support for Swift 5.8 swift-actions/setup-swift#549

Example change: https://github.com/SwiftPackageIndex/setup-swift/pull/1/files

Update PackageList

Preconditions:

• new Swift docker image available (alternatively, use a nightly toolchain)

• step Update setup-swift GH action

• Update PackageList

• Merge Bump Swift version to 5.8 PackageList#3797

Example change: https://github.com/SwiftPackageIndex/PackageList/pull/3797/files

Update PackageList-Validator

Preconditions:

• new Swift docker image available (automatically ensured by package CI)
• setp Update setup-swift GH action

This ensures via the CI build that the validator binary which is built in the PackageList repository can be built successfully with the latest Swift version.

• Update PackageList-Validator
• Merge Bump to Swift 5.8 PackageList-Validator#41

Example change: https://github.com/SwiftPackageIndex/PackageList-Validator/pull/41/files

Update spi-images

Preconditions: new Swift docker image available (automatically ensured by package CI)

The images don't need to be tagged, as they are automatically picked up via their .../spi-images:basic-5.8-latest tag.

• Update the Swift versions in the image build matrix of spi-images
• Merge https://gitlab.com/finestructure/spi-images/-/merge_requests/3

Example change: https://gitlab.com/finestructure/spi-images/-/merge_requests/3/diffs

Update builder machines

Preconditions: new Xcode version available

• Install the Xcode version on all macOS builders
• Set a runner tag for the new version swift-x.y in builder CI/DC

Update Builder

Preconditions:

• step Update builder machines

• step Update spi-images

• Update to new SPIManifest version and address all issues arising from non-exhaustive switch statements.

• Update Makefile to build and test with new Xcode version

• Update .gitlab-ci-builder.yml: add/remove build <platform> <swift-version> blocks.

• Update .gitlab-ci-testmatrix.yml: add/remove new test <platform> <swift-version> jobs

• Merge https://gitlab.com/finestructure/swiftpackageindex-builder/-/merge_requests/196

Example change: https://gitlab.com/finestructure/swiftpackageindex-builder/-/merge_requests/196/diffs

Update spi-base

Preconditions: new Swift docker image available (automatically ensured by package CI)

• Update spi-base
• Merge https://gitlab.com/finestructure/spi-base/-/merge_requests/12
• Tag new version (as 0.10.0)

Example change: https://gitlab.com/finestructure/spi-base/-/merge_requests/12/diffs

Update Server

Preconditions:

• step Update Builder

• step Update spi-base

• Update SPIManifest dependency

• Update spi-base to newly tagged version

• Update SwiftVersion+Build.swift and adjust to changes

• Update PackageShow.Model.SwiftVersionResults and adjust to changes

• Ensure any new SupportedPlatform keys are added to our matching Manifest.Platform.Name enum so we don’t fail to decode package manifests that use them. (See issue 1441 for details.)

• Merge Swift 5.8 #2313

• set BUILD_TRIGGER_LATEST_SWIFT_VERSION_DOWNSCALING to 0.2

• Deploy

Example change: https://github.com/SwiftPackageIndex/SwiftPackageIndex-Server/pull/2313/files

Delete old Swift version builds

Preconditions: New server (one that doesn't trigger the Swift version to be deleted) has been deployed

Nothing needs to be done with respect to database content when adding a new version.

When removing Swift versions, it's important to remove its builds from the builds table, because the total count of builds per version is used as a trigger signal. (See #1267 (comment) for details.)

• Delete outdated builds
  • dev
  • prod

Example SQL:

delete
from builds
where
swift_version->'major' = '5'
and swift_version->'minor' = '4'

This should be run once the new Server has been deployed. Running it too early will lead to the deleted versions being triggered again. It's harmless but wastes build resources.

Deleting the records too long after deployment will inhibit triggering of the new Swift versions, because the presence of the old records will make the build result set appear to be complete. This is also harmless, as these will then be triggered once the deletion has happened.

Post deployment

Preconditions: all the above steps have been completed, not time critical

• Remove obsolete runner tag swift-x.y in builder CI/DC
• Change back to swift-actions/setup-swift after Swift version change has been upstreamed → Change PackageList, PackageList-Validator back to swift-actions/setup-swift  #2323
  • PackageList
  • PackageList-Validator

[daveverwer]

Either as part of this or as a separate stage afterwards, we can remove Swift 5.4, which would free up mb3 to become a Ventura build machine and mean we only have to maintain two different macOS versions rather than three.

[finestructure]

We should do this while adding 5.8. It makes adjusting all the test expectations easier when we're just shuffling them around. Otherwise we'll have to do considerable structural changes twice.

[ahmdyasser]

@finestructure Can I work on that?

[finestructure]

Thanks for your offer to help out with this one, @ahmdyasser!

This is probably one of the fiddliest things we do twice a year and it has to be me who does it, I'm afraid 😅

However, we do still have a couple of good first issues that might be a great way to contribute. Would one of those interest you?

[finestructure]

All the prep work is done. We're ready when Xcode-14.3 and swift:5.8-focal drop.

[finestructure]

Swift 5.8 processing is under way. Remaining todos tracked here: #2323