Skip to content

update package deps for custom project root #1412

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

Merged
merged 3 commits into from
Jul 25, 2025
Merged

update package deps for custom project root #1412

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8847bb4
package deps
vanvoorden Jul 9, 2025
550fe23
checkout collections 1.1.0
vanvoorden Jul 21, 2025
a4c43bc
package deps comment
vanvoorden Jul 22, 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
24 changes: 16 additions & 8 deletions Package.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,32 +42,40 @@ let featureSettings: [SwiftSetting] = [
.enableUpcomingFeature("MemberImportVisibility")
]

var dependencies: [Package.Dependency] {
if Context.environment["SWIFTCI_USE_LOCAL_DEPS"] != nil {
var dependencies: [Package.Dependency] = []

if let useLocalDepsEnv = Context.environment["SWIFTCI_USE_LOCAL_DEPS"], !useLocalDepsEnv.isEmpty {
let root: String
if useLocalDepsEnv == "1" {
root = ".."
} else {
root = useLocalDepsEnv
}
dependencies +=
[
.package(
name: "swift-collections",
path: "../swift-collections"),
path: "\(root)/swift-collections"),
.package(
name: "swift-foundation-icu",
path: "../swift-foundation-icu"),
path: "\(root)/swift-foundation-icu"),
.package(
name: "swift-syntax",
path: "../swift-syntax")
path: "\(root)/swift-syntax")
]
} else {
} else {
dependencies +=
[
.package(
url: "https://github.com/apple/swift-collections",
from: "1.1.0"),
branch: "main"),
Copy link
Contributor

Choose a reason for hiding this comment

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

We actually want to keep this at 1.1.0 instead of main since these versions should match what we use for building the toolchain. When building the swift toolchain, the build script builds against swift-syntax and swift-foundation-icu's main branch, but it builds against a tag of swift-collections since that package is developed outside of the toolchain and tagged every so often. When building a toolchain, this JSON file determines what is checked out: https://github.com/swiftlang/swift/blob/3bacfa7fb974e89ad7278f727ccd54a6643b87b6/utils/update_checkout/update-checkout-config.json#L142 (i.e. it determines what branch/tag is checked out and then specified via SWIFTCI_USE_LOCAL_DEPS when running in CI) so ideally these dependencies (for local package development outside of the toolchain) will use the same-ish dependencies

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@jmschonfeld Ahh… interesting! I can change this back. Is the idea to keep this version here and the version from update-checkout-config.json bound together manually? We don't have any easy way to keep that version defined in just one place and then queried dynamically?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Does this all then imply that we don't currently have a Foundation CI job that builds against the main commit on Swift-Collections? If in theory a bad commit did land on Collections that broke something in Foundation we might not know about it until Collections pushes a new version tag?

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes unfortunately these versions need to be kept in sync manually. update-checkout-config.json is considered the source of truth as it defines what refs of each project are checked out when building a toolchain. We also provide the dependencies in our SwiftPM and CMake manifests as conveniences to quickly check out / build dependencies locally without building the entire toolchain. Unfortunately there aren't any mechanisms today (and it would not be possible to build one for the SwiftPM manifest at least) that could read the dependency information from an external source. While this is a manual process, these versions are not typically updated frequently and the maintenance burden has been minimal so far.

And you're correct that if an issue landed on main of swift-collections that broke something in Foundation we may not find it until qualifying a new swift-collections tag. This is the case for many of the open source packages that are used by the toolchain. Foundation (being a public component of the toolchain) is always built in tangent with the toolchain but many other packages like swift-collections, swift-algorithms, swift-argument-parser, etc. all use stable tags instead of the unstable main branch when building in the toolchain.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@jmschonfeld That all makes sense. Thanks!

.package(
url: "https://github.com/apple/swift-foundation-icu",
branch: "main"),
.package(
url: "https://github.com/swiftlang/swift-syntax",
branch: "main")
]
}
}

let wasiLibcCSettings: [CSetting] = [
Expand Down