Improve Usability of `replace-scm-with-registry` by thePianoKid · Pull Request #9966 · swiftlang/swift-package-manager

thePianoKid · 2026-04-20T17:52:50Z

Add replaceScmWithRegistry attribute to registries.json. Resolves #9854.

Motivation:

There is a no global option, or at least per repo that could enable the --replace-scm-with-registry option? This is very error prone to have to setup alias scripts to do use correct flag.

Result:

Devs can now transform SCM dependencies to registry ones globally or on a per-project basis by including "replaceScmWithRegistry": true, in .swiftpm/configuration/registries.json

Manual Testing

Make a package like the one in WorkspaceTests.testRegistriesJsonReplaceScmWithRegistryDrivesSwizzle. Make sure that SPM picks up "replaceScmWithRegistry": true,.

Explore other edge cases like not including "replaceScmWithRegistry", passing in an illegal value, etc...

Blocked by #10036

thePianoKid · 2026-04-20T18:38:10Z

#9854 suggested that this config be added to https://github.com/apple/swift-configuration.

replaceScmWithRegistry was added to registries.json instead because swift-configuration is separate from SPM, and was built to manage configuration that is passed in at runtime. Adding this configuration option directly to SPM made the most sense to me.

bripeticca · 2026-04-20T19:51:10Z

@swift-ci test

thePianoKid · 2026-04-21T15:26:14Z

@swift-ci test windows

thePianoKid · 2026-04-21T15:27:19Z

@swift-ci test macOS

bripeticca

Overall LGTM, just a couple questions:

Have we considered that the use of --replace-scm-with-registry in the CLI in turn populates the registries.json with this value set, or are we treating these as strictly separate concepts where the CLI will override whatever is present in the registries.json?
If the latter, will users have to explicitly declare this property in the registries.json themselves?
If the CLI option does affect whether the replace scm flag is persisted to the registries.json file, do we write to the registries.json when this happens? Does the RegistryConfiguration encoding work as expected?

bripeticca · 2026-04-21T15:48:20Z

+        let json = #"""
+        {
+            "authentication": {},
+            "replaceScmWithRegistry": "Bob, I don't think this is valid",


bripeticca · 2026-04-22T14:19:36Z

@swift-ci test windows

thePianoKid · 2026-04-30T15:13:57Z

+        // registries.json acts as a default; an explicit CLI flag overrides.
+        let effectiveTransformation: WorkspaceConfiguration.SourceControlToRegistryDependencyTransformation = {
+            if let cliValue = configuration.sourceControlToRegistryDependencyTransformation {
+                return cliValue
+            }
+            if registriesConfiguration.replaceScmWithRegistry == true {
+                return .swizzle
+            }
+            return .disabled
+        }()


Overall LGTM, just a couple questions:

--replace-scm-with-registry doesn't write to registries.json. The transformation used is determined by this logic.

CLI takes precedent over what's in registries.json, which takes precedent over the default (which is a .disabled transformation).

Users will have to know to include this new attribute in registries.json. That raises a good question: what's the best way to tell SPM users about this new attribute?

plemarquand · 2026-04-30T15:26:13Z

        }

        try container.encode(self.registryAuthentication, forKey: .authentication)
        try container.encodeIfPresent(self.security, forKey: .security)


We should also be encoding replaceScmWithRegistry

Done in 1d11d2a

thePianoKid · 2026-05-01T13:23:52Z

@swift-ci test windows

thePianoKid · 2026-05-01T13:24:48Z

@swift-ci test mac

thePianoKid · 2026-05-01T13:24:55Z

@swift-ci test linux

thePianoKid · 2026-05-01T13:25:36Z

@swift-ci test macOS

bkhouri · 2026-05-05T04:00:31Z

@swift-ci test windows

bkhouri · 2026-05-05T04:06:04Z

+        XCTAssertThrowsError(try self.decoder.decode(RegistryConfiguration.self, from: json))
+    }
+
+    func testDecodeConfigurationWithMissingReplaceScmWithRegistry() throws {


suggestion: consider migrating this test suite to Swift Testing, and utilizing the parameterized tests for test implementation that are similar.

Does that belong in this PR? What if I add a new migration PR and stack it on top of this one?

There is no need to convert to Swift Testing in this PR.

Perfect. I will make a new PR that is blocked by this one.

bkhouri · 2026-05-05T04:07:28Z

+        """#)
+
+        // Case 1: no CLI override → registries.json drives .swizzle.
+        do {


suggestion: consider migrating this test suite to Swift Testing, and utilizing the parameterized tests for test implementation that are similar.

thePianoKid · 2026-05-11T14:53:10Z

@swift-ci test self hosted windows

bkhouri · 2026-05-11T14:54:35Z

@swift-ci test self hosted windows

bkhouri · 2026-05-11T15:50:39Z

@swift-ci test self hosted windows

thePianoKid · 2026-05-11T17:04:05Z

@swift-ci test self hosted windows

thePianoKid added 5 commits April 20, 2026 12:29

Added tests for replaceScmWithRegistry attribute

a723b75

Added attribute so tests pass

4ae3483

Made attribute optional, added test

9ad0166

Read transformation attribute from registry config

ff57b49

Added workspace integration test

c3d1967

thePianoKid marked this pull request as ready for review April 20, 2026 17:53

thePianoKid requested review from bkhouri, bripeticca, cmcgee1024, daveinglis, daveyc123, dschaefer2, jakepetroules, owenv, plemarquand and rconnell9 as code owners April 20, 2026 17:53

bripeticca reviewed Apr 21, 2026

View reviewed changes

thePianoKid commented Apr 30, 2026

View reviewed changes

thePianoKid requested a review from bripeticca April 30, 2026 15:15

plemarquand reviewed Apr 30, 2026

View reviewed changes

thePianoKid added 4 commits April 30, 2026 15:03

Encoded attribute

1d11d2a

Merge branch 'main' into improve-replace-scm-usability

753c933

Added default transformation type

27fdfd9

Added default case

63f34a1

thePianoKid requested a review from plemarquand April 30, 2026 21:15

plemarquand approved these changes Apr 30, 2026

View reviewed changes

bkhouri reviewed May 5, 2026

View reviewed changes

thePianoKid mentioned this pull request May 11, 2026

Improve Usability of replace-scm-with-registry (resubmission) #10047

Closed

thePianoKid enabled auto-merge May 11, 2026 14:51

Merge branch 'main' into improve-replace-scm-usability

b6237e6

thePianoKid mentioned this pull request May 12, 2026

Migrate workspace tests #10050

Draft

Conversation

thePianoKid commented Apr 20, 2026 • edited by bkhouri Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Motivation:

Result:

Manual Testing

Uh oh!

thePianoKid commented Apr 20, 2026

Uh oh!

bripeticca commented Apr 20, 2026

Uh oh!

thePianoKid commented Apr 21, 2026

Uh oh!

thePianoKid commented Apr 21, 2026

Uh oh!

bripeticca left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bripeticca commented Apr 22, 2026

Uh oh!

thePianoKid Apr 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

thePianoKid commented May 1, 2026

Uh oh!

thePianoKid commented May 1, 2026

Uh oh!

thePianoKid commented May 1, 2026

Uh oh!

thePianoKid commented May 1, 2026

Uh oh!

bkhouri commented May 5, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

thePianoKid commented May 11, 2026

Uh oh!

bkhouri commented May 11, 2026

Uh oh!

bkhouri commented May 11, 2026

Uh oh!

thePianoKid commented May 11, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

thePianoKid commented Apr 20, 2026 •

edited by bkhouri

Loading

thePianoKid Apr 30, 2026 •

edited

Loading