1.10.0

[stephencelis]

Breaking changes

• Changed: The package name has been changed from SnapshotTesting to swift-snapshot-testing, to better reflect community naming conventions (Update package name #555). This may require you to update any Package.swift files that depend on Snapshot Testing.
• Deprecated: support for CocoaPods and Carthage has been deprecated. Please use the Swift Package Manager to depend on Snapshot Testing.
• Deprecated: Snapshot Testing now requires Swift 5.5+, as well at iOS 13+, macOS 10.15+, tvOS 13+, and watchOS 6+.

Warning: The following updates change how a strategy may output a snapshot, causing existing snapshot suites to fail. When upgrading, please rerecord your failing snapshots and audit the changes.

• Fixed: A UIViewController strategy was not passing along the correct trait collection (thanks @arnopoulos, Fixes display scaling bug #554).
• Fixed: iPhone XS Max portrait configuration was not applying base traits (thanks @imvm, Fix iPhone XS Max portrait traits #417)
• Fixed: URLRequest strategy now sorts query items for more consistent diffing (thanks @mihai8804858, Sort URL query items #491).
• Removed: GLKView is no longer supported (thanks @jpsim, Remove GLKView support #507).

Everything else

• Added: Image-based strategies have a new perceptualPrecision option, which can be used to support snapshot tests across Intel and M1 devices. Along for the ride is a 90+% speed improvement to the strategies (thanks @ejensen, Perceptual image precision + 90% speed improvement #628).
• Added: Windows support, CI (thanks @MaxDesiatov, Add support for Windows, add Windows job to ci.yml #532).
• Added: Failure messages now include the snapshot name, if given (thanks @calda, Include snapshot name in failure message, if given #547).
• Added: iPhone 13 configs (thanks @luispadron, Add iPhone 13 devices #603).
• Added: iPad 9.7" and iPad 10.2" configs (thanks @skols85, Add support for iPad 9_7 and iPad 10_2 #405).
• Added: iPhone 12 and iPhone 12 Pro Max configs(thanks @imvm, Add iPhone 12 and iPhone 12 Pro Max configs #418).
• Added: Snapshotting.json for Any value (thanks @NachoSoto, Added Snapshotting.json for Any value #552).
• Added: Newly-recorded snapshots are now attached to the test run (thanks @marcelofabri, Attach recorded snapshot #586).
• Fixed: the UIImage strategy was using the device scale instead of the scale of the given images (thanks @codeman9, Use the correct scale for the diff image #472).
• Fixed: the UIImage strategy now compares image contexts using the same colorspace (thanks @dflems, Compare image contexts in same colorspace #446).
• Fixed: the WebView strategy no longer overrides the delegate (thanks @teameh in Fix #440 Webview loading without delegate (option 2) #443).
• Fixed: Patched a leak when running tests in a host application (thanks @llinardos, Leak when running with Host Application #511).
• Fixed: False positive when asserting reference image with empty image (thanks @nuno-vieira, Fix false positive when asserting reference image with empty image #453).
• Fixed: watchOS compilation (thanks @aydegee, Include watchOS 4.0 in @available check #579).
• Fixed: Support for repeatedly running tests (thanks @krzysztofpawski, Add support for tests executed repeatedly #585).
• Infrastructure: Add swift-snapshot-testing-stitch to plugins list (thanks @Sherlouk, Add swift-snapshot-testing-stitch to plugins list #483)
• Infrastructure: Document diff tool configuration.
• Infrastructure: README updates (thanks @MaatheusGois, @gohanlon), documentation fixes (thanks @heckj, @valeriyvan).
• Infrastructure: Added GitHub issue templates (Add Issue Templates #556).
• Infrastructure: Add SnapshotTestingHEIC to plugins list (thanks @alexey1312, Add SnapshotTestingHEIC to plugins list #561).

New Contributors

• @arietis made their first contribution in bump .podspec #468
• @codeman9 made their first contribution in Use the correct scale for the diff image #472
• @Nikoloutsos made their first contribution in Readme update pod to latest version 1.9 #482
• @mihai8804858 made their first contribution in Sort URL query items #491
• @dflems made their first contribution in Compare image contexts in same colorspace #446
• @skols85 made their first contribution in Add support for iPad 9_7 and iPad 10_2 #405
• @imvm made their first contribution in Add iPhone 12 and iPhone 12 Pro Max configs #418
• @teameh made their first contribution in Fix #440 Webview loading without delegate (option 2) #443
• @MaatheusGois made their first contribution in Update tag version to SPM #496
• @calda made their first contribution in Include snapshot name in failure message, if given #547
• @MaxDesiatov made their first contribution in Add support for Windows, add Windows job to ci.yml #532
• @jpsim made their first contribution in Remove GLKView support #507
• @arnopoulos made their first contribution in Fixes display scaling bug #554
• @llinardos made their first contribution in Leak when running with Host Application #511
• @heckj made their first contribution in minor typo correction #601
• @aydegee made their first contribution in Include watchOS 4.0 in @available check #579
• @valeriyvan made their first contribution in Fix typo #630
• @ejensen made their first contribution in Perceptual image precision + 90% speed improvement #628
• @luispadron made their first contribution in Add iPhone 13 devices #603
• @alexey1312 made their first contribution in Add SnapshotTestingHEIC to plugins list #561
• @gohanlon made their first contribution in Improve warning about view snapshot discrepancies #592
• @marcelofabri made their first contribution in Attach recorded snapshot #586
• @nuno-vieira made their first contribution in Fix false positive when asserting reference image with empty image #453
• @krzysztofpawski made their first contribution in Add support for tests executed repeatedly #585

Full Changelog: 1.9.0...1.10.0

---

This discussion was created from the release 1.10.0.

[MagFer]

Good afternoon @stephencelis, is there a chance to bring back support to Carthage or create a precompiled XCFramework for every release?

I see there are other people interested in this feature: #648.
FYI @lazar-otasevic-cif

[NachoSoto]

It is unfortunate that this breaking change was released in a "minor" release though. I had to fix a bunch of repos that got this update automatically and no longer built.

[stephencelis]

@NachoSoto Sorry about that! I know that switching from CocoaPods/Carthage is not trivial, and neither is maintaining your own Podfile or Xcode project file for Carthage support, but just to understand, the act of releasing this new version didn't break your existing projects, right? It's more that you had to do some work to upgrade?

While we understand that there's some friction in removing official support for these distribution mechanisms, we aim to keep our SemVer versioning based off source compatibility, not distribution management: #647 (comment)

[NachoSoto]

but just to understand, the act of releasing this new version didn't break your existing projects, right? It's more that you had to do some work to upgrade?

It did. Not a huge deal, but I had to change the version specifier from 1.x to hardcode 1.9.0 (both in projects using CocoaPods and Carthage).

While we understand that there's some friction in removing official support for these distribution mechanisms, we aim to keep our SemVer versioning based off source compatibility, not distribution management

I see. But unfortunately that decision meant that overnight several projects I work on stopped working until I made that change.

[stephencelis]

Hm, I'm actually surprised that CocoaPods would break since the specs are hosted by them, though I do understand how Carthage would break. Sorry again for the breakage. It's a learning experience for us, but a little late for us to back out of now.

[MagFer]

Good afternoon @stephencelis.

We've done the same as @NachoSoto, and fixed the framework version to 1.9.0 in the Cartfile. There's not a significant inconvenience moving from CocoaPods to SPM. However, the precompiled XCFrameworks from Carthage make life easier.

Do you have any advice on how to generate a v1.10.0 XCFramework? Could we run the following command?
carthage build --no-skip-current

[balavor]

Carthage still works better for large projects since SPM is not able to pre-build dependencies in cross-platform xcframeworks. And it doesn't fetch the entire repo from the origin...

[MagFer]

Hi all!

Do we have news on how to use a newer swift-snapshot-testing version than 1.9.0 in Carthage or download the XCFramework?

We are still using v1.9.0 and I don't think we can precompile a Swift package using the next command, since the library repo doesn't have any Xcode project file.

xcrun xcodebuild archive \
  -workspace . \
  -scheme {scheme} \
  -configuration Release \
  -destination 'generic/platform=iOS' \
  -derivedDataPath '.build' \
  -archivePath './.build/Release/{library}-iphoneos.xcarchive' \
  -allowProvisioningUpdates \
  SKIP_INSTALL=NO \
  BUILD_LIBRARY_FOR_DISTRIBUTION=YES

I haven't found posts on how to precompile a Swift Package either.
https://forums.swift.org/t/how-to-build-swift-package-as-xcframework/41414/51