Skip to content

docs: Add Swift 6.3 compatibility limitations to README #9

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

Open
doozMen wants to merge 1 commit into
base: fix/add-swift63-warnings
Choose a base branch
from
Open

docs: Add Swift 6.3 compatibility limitations to README #9

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ CloudKit synchronization.
[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fpointfreeco%2Fsqlite-data%2Fbadge%3Ftype%3Dswift-versions)](https://swiftpackageindex.com/pointfreeco/sqlite-data)
[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fpointfreeco%2Fsqlite-data%2Fbadge%3Ftype%3Dplatforms)](https://swiftpackageindex.com/pointfreeco/sqlite-data)

* [Swift 6.3 Compatibility](#Swift-63-Compatibility)
Copy link

@graphite-app graphite-app bot Dec 13, 2025

Choose a reason for hiding this comment

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

The table of contents anchor link #Swift-63-Compatibility won't correctly navigate to the section. GitHub markdown auto-generates anchors from headers in lowercase with hyphens. The anchor should be:

* [Swift 6.3 Compatibility](#swift-63-compatibility)

The current link with capital letters will result in a broken navigation link when users click on it in the table of contents.

Suggested change
* [Swift 6.3 Compatibility](#Swift-63-Compatibility)
* [Swift 6.3 Compatibility](#swift-63-compatibility)

Spotted by Graphite Agent

Fix in Graphite

Is this helpful? React 👍 or 👎 to let us know.

* [Learn more](#Learn-more)
* [Overview](#Overview)
* [Quick start](#Quick-start)
Expand All @@ -20,6 +21,21 @@ CloudKit synchronization.
* [Community](#Community)
* [License](#License)

## Swift 6.3 Compatibility

**Important**: CloudKit functionality is temporarily disabled when building with Swift 6.3-dev due to compiler crashes ([#2](https://github.com/doozMen/sqlite-data/issues/2)).

### Affected Features (Swift 6.3+)
- CloudKit synchronization (`SyncEngine`)
- CloudKit sharing (`CloudKitSharing`)
- All CloudKit-related APIs

### Workaround
Use Swift 6.2.x if you need CloudKit features. Core SQLite functionality (queries, `@FetchAll`, `@FetchOne`) works on all Swift versions.

### Timeline
These limitations will be removed once the Swift compiler bugs are fixed. We test against new Swift snapshots regularly.

## Learn more

This library was motivated and designed over the course of many episodes on
Expand Down