Skip to content

Commit ce476bd

Browse files
committed
📝 Polish Swift SDK release notes
Replace the fallback Swift v0.1.0 changelog with a real first-release summary that explains the SDK surface, TDD discovery behavior, option alignment, and verification coverage.
1 parent e71cc8b commit ce476bd

1 file changed

Lines changed: 34 additions & 19 deletions

File tree

clients/swift/CHANGELOG.md

Lines changed: 34 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,44 @@
11
# Vizzly Swift SDK Changelog
22

3-
## [0.1.0] - 2026-06-01
4-
5-
## What's Changed
6-
7-
Release v0.1.0
8-
9-
See the full diff for detailed changes.
10-
11-
123
All notable changes to the Vizzly Swift SDK will be documented in this file.
134

145
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
156
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
167

178
## [Unreleased]
189

10+
## [0.1.0] - 2026-06-01
11+
12+
### What's Changed
13+
14+
This is the first tagged release of the Vizzly Swift SDK. It gives iOS and
15+
macOS test suites a small Swift Package Manager client for sending screenshots
16+
to Vizzly from XCTest, without needing each app to hand-roll the HTTP payloads
17+
or local TDD server discovery.
18+
1919
### Added
20-
- Initial Swift SDK implementation
21-
- Core `VizzlyClient` class with HTTP communication
22-
- Auto-discovery of TDD server via `.vizzly/server.json`
23-
- XCTest integration extensions for `XCUIApplication`, `XCUIElement`, and `XCTestCase`
24-
- Automatic metadata capture (platform, device, viewport)
25-
- iOS and macOS support
26-
- Environment variable configuration support
27-
- Graceful error handling and client disabling
28-
- Comprehensive example UI tests
29-
- Full documentation and README
20+
21+
- Added the `Vizzly` Swift package with two library products:
22+
- `Vizzly`, the core screenshot upload client.
23+
- `VizzlyXCTest`, convenience helpers for `XCTestCase`, `XCUIApplication`,
24+
and `XCUIElement`.
25+
- Added local TDD server discovery through `VIZZLY_SERVER_URL`,
26+
project-local `.vizzly/server.json`, global `.vizzly/server.json`, and the
27+
default TDD port fallback.
28+
- Added screenshot uploads with base64 PNG payloads, `buildId` support,
29+
request timeouts, and graceful disabling after connection or server failures.
30+
- Added XCTest-friendly metadata capture for platform, device, OS, viewport,
31+
and element type while still letting user-provided `properties` win.
32+
- Added comparison options for `threshold`, `minClusterSize`, and `fullPage`
33+
so Swift screenshots use the same option contract as the other SDKs.
34+
- Added `failOnDiff` support from explicit client configuration,
35+
`VIZZLY_FAIL_ON_DIFF`, and discovered TDD server settings.
36+
37+
### Tested
38+
39+
- Added Swift unit coverage for payload shape, comparison options, build IDs,
40+
metadata merging, disabled clients, and client state.
41+
- Added Swift SDK E2E coverage that runs through the real local Vizzly TDD
42+
server and verifies screenshots can be uploaded, repeated, and matched.
43+
- The release workflow builds and tests the Swift package before tagging the
44+
release.

0 commit comments

Comments
 (0)