docs: update version references to alpha releases by leogdion · Pull Request #72 · brightdigit/SundialKit

leogdion · 2025-11-25T14:30:10Z

Summary

Updates all documentation and demo package dependencies to reference the correct alpha versions:

SundialKit: 2.0.0-alpha.1
SundialKitStream: 1.0.0-alpha.1
SundialKitCombine: 1.0.0-alpha.1

Changes

✅ README.md: Update installation examples to use alpha versions
✅ SundialKit.docc/Documentation.md: Update DocC installation example
✅ Examples/Sundial/Package.swift: Convert from branch refs to version tags
✅ Examples/Sundial/README.md: Update version in project description

Rationale

This ensures users understand they're working with pre-release software and demo builds use stable version references instead of branch heads.

Notes

⚠️ Waiting for tags: This PR is marked as draft until the 1.0.0-alpha.1 tags are created and pushed for SundialKitStream and SundialKitCombine repositories. Once those tags are available, this PR can be marked ready for review.

🤖 Generated with Claude Code

Perform an AI-assisted review on

Summary by CodeRabbit

Documentation
- Updated package dependency version references to alpha releases across documentation and examples for SundialKit, SundialKitCombine, and SundialKitStream packages.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

Update all documentation and demo package dependencies to reference the correct alpha versions: - SundialKit: 2.0.0-alpha.1 - SundialKitStream: 1.0.0-alpha.1 - SundialKitCombine: 1.0.0-alpha.1 Changes: - README.md: Update installation examples to use alpha versions - SundialKit.docc/Documentation.md: Update DocC installation example - Examples/Sundial/Package.swift: Convert from branch refs to version tags - Examples/Sundial/README.md: Update version in project description This ensures users understand they're working with pre-release software and demo builds use stable version references instead of branch heads. Note: Waiting for SundialKitStream and SundialKitCombine tags to be created before enabling CI. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>

coderabbitai · 2025-11-25T14:30:31Z

Walkthrough

The pull request updates Swift Package dependencies from branch-based pins to explicit alpha version pins across configuration and documentation files. Three dependencies (SundialKit, SundialKitCombine, SundialKitStream) are transitioned to prerelease versions (2.0.0-alpha.1 and 1.0.0-alpha.1) with corresponding documentation updates.

Changes

Cohort / File(s)	Summary
Package Configuration `Examples/Sundial/Package.swift`	Three Swift Package dependencies updated from branch-based to version-based pinning: SundialKit (branch "v2.0.0" → from: "2.0.0-alpha.1"), SundialKitCombine (branch "v1.0.0" → from: "1.0.0-alpha.1"), SundialKitStream (branch "v1.0.0" → from: "1.0.0-alpha.1")
Documentation & Examples `Examples/Sundial/README.md`, `README.md`, `Sources/SundialKit/SundialKit.docc/Documentation.md`	Version references updated from released versions to alpha prerelease versions in documentation and package manager examples (2.0.0 → 2.0.0-alpha.1)

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Consistent, repetitive pattern across all changes (dependency and documentation version updates)
Low logical complexity; changes are straightforward version bumps
No behavioral or structural modifications

Poem

🐰 A hop and a skip through versions we go,
From branches to tags, let the alpha code flow!
Pre-release dreams in the Sundial's embrace,
Three packages dancing to time's quickened pace! ⏰✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The PR title 'docs: update version references to alpha releases' directly and accurately summarizes the main change—updating documentation and package references from released versions to alpha pre-release versions across multiple files.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

📝 Generate docstrings

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch docs/update-alpha-version-references

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ff0e3f2 and 9f35dab.

📒 Files selected for processing (4)

Examples/Sundial/Package.swift (1 hunks)
Examples/Sundial/README.md (1 hunks)
README.md (1 hunks)
Sources/SundialKit/SundialKit.docc/Documentation.md (1 hunks)

🧰 Additional context used

📓 Path-based instructions (2)

**/*.swift

📄 CodeRabbit inference engine (CLAUDE.md)

**/*.swift: Swift 6.1+ is required for all code in this repository; v2.0.0 dropped support for Swift 5.9, 5.10, and 6.0 to enable Swift Testing framework migration
Use #if canImport(Combine) and @available attributes to guard platform-specific APIs (WatchConnectivity on iOS/watchOS only, not macOS/tvOS)
Use swift-format (swiftlang/swift-format@602.0.0) as the official formatter via ./Scripts/lint.sh or make lint command
Use SwiftLint (realm/SwiftLint@0.61.0) for style and conventions linting via ./Scripts/lint.sh or make lint command
Use Periphery (peripheryapp/periphery@3.2.0) for detecting unused code via ./Scripts/lint.sh or make lint command
Never* types (NeverPing, NeverConnectivitySession) must be used for platforms without certain capabilities; provide no-op implementations

Files:

Examples/Sundial/Package.swift

{Package.swift,**/Package.swift}

📄 CodeRabbit inference engine (CLAUDE.md)

{Package.swift,**/Package.swift}: Support iOS 16, watchOS 9, tvOS 16, and macOS 11.0 as minimum deployment targets
Use Swift Package Manager (SPM) for dependency management; SundialKitStream and SundialKitCombine are distributed as separate remote packages referenced in Package.swift

Files:

Examples/Sundial/Package.swift

🧠 Learnings (13)

📓 Common learnings

Learnt from: CR
Repo: brightdigit/SundialKit PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-11-24T22:42:18.533Z
Learning: Applies to {Package.swift,**/Package.swift} : Use Swift Package Manager (SPM) for dependency management; SundialKitStream and SundialKitCombine are distributed as separate remote packages referenced in Package.swift

Learnt from: CR
Repo: brightdigit/SundialKit PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-11-24T22:42:18.533Z
Learning: Applies to **/*.swift : Swift 6.1+ is required for all code in this repository; v2.0.0 dropped support for Swift 5.9, 5.10, and 6.0 to enable Swift Testing framework migration

Learnt from: CR
Repo: brightdigit/SundialKit PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-11-24T22:42:18.533Z
Learning: Applies to **/SundialKitStream/**/*.swift : Maintain zero unchecked Sendable annotations in SundialKitStream plugin; rely on naturally Sendable actors instead

Learnt from: CR
Repo: brightdigit/SundialKit PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-11-24T22:42:18.533Z
Learning: Applies to **/SundialKitCombine/**/*.swift : Maintain zero unchecked Sendable annotations in SundialKitCombine plugin; rely on MainActor isolation instead