Skip to content

README + CI consistency cleanup#6

Merged
joelnishanth merged 1 commit into
mainfrom
codex/update-readme-and-clean-ci-workflow
Apr 26, 2026
Merged

README + CI consistency cleanup#6
joelnishanth merged 1 commit into
mainfrom
codex/update-readme-and-clean-ci-workflow

Conversation

@joelnishanth

Copy link
Copy Markdown
Collaborator

Motivation

  • Align documentation with the package toolchain (// swift-tools-version: 6.1) and avoid implying perfect semantic retention in the reduced output.
  • Make CI validate the local Swift environment and package lifecycle (describe, build, test) on the same macOS runner used previously.

Description

  • Update README Requirements from Swift 5.9+ to Swift 6.1+ to match Package.swift.
  • Rename the benchmark table column from mlx-swift-chain Coverage to mlx-swift-chain Model-Visible Coverage.
  • Add the sentence under the benchmark table: Coverage here means input/model-visible coverage across chunks, not guaranteed perfect retention in the final reduced answer.
  • Expand .github/workflows/ci.yml to run swift --version, swift package describe, and swift build before swift test, and keep runs-on: macos-15 unchanged.
  • Leave Package.swift and package architecture unchanged.

Testing

  • Ran swift --version, which succeeded and reported the installed Swift version.
  • Ran swift package describe, which succeeded and produced the package description.
  • Ran swift build, which failed in this environment due to a dependency fetch error (HTTP 403) when cloning https://github.com/ml-explore/mlx-swift-lm.
  • Ran swift test, which also failed for the same dependency fetch error in this environment.

Codex Task

@joelnishanth
joelnishanth merged commit be100b1 into main Apr 26, 2026
2 checks passed
@joelnishanth
joelnishanth deleted the codex/update-readme-and-clean-ci-workflow branch May 6, 2026 05:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant