FFFF docs: v2.0.1 tag now resolves; fix older-release pinning advice by adityamukho · Pull Request #4 · project-minigraf/minigraf-swift · GitHub
[go: up one dir, main page]
Skip to content

docs: v2.0.1 tag now resolves; fix older-release pinning advice #4

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

Merged
adityamukho merged 1 commit into from
Sep 26, 2026
Merged

docs: v2.0.1 tag now resolves; fix older-release pinning advice #4

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
17 changes: 11 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,20 +20,25 @@ dependencies: [
> Each semver tag `v<version>` points to a commit on the `swift-releases` branch. That commit
> holds the `Package.swift` with the release's xcframework URL and checksum, plus the generated
> Swift sources. The matching source commit on `main` is tagged `source-v<version>`.
> Releases up to v2.0.1 were tagged differently; see
> [Older releases](#older-releases) below.
> Releases up to v2.0.0 were tagged differently; see [Older releases](#older-releases) below.
> The `v2.0.1` tag was moved to its `swift-releases` commit after the fact, so it resolves normally
> but has no `source-v2.0.1` tag.

### Older releases

Before the tagging fix, the release workflow put the semver tag on the source commit, whose
`Package.swift` has a placeholder checksum and no generated sources. Those tags do not resolve.
For those versions, the working manifest is on the `swift-v<version>` tag instead, which SPM
cannot resolve by version. Pin the `swift-releases` branch or a specific revision instead:
`Package.swift` has a placeholder checksum and no generated sources. The tags `v2.0.0` and
earlier do not resolve. For those versions, the working manifest is on the `swift-v<version>`
tag, which SPM cannot resolve by version. Pin that tag's commit instead, for example:

```swift
.package(url: "https://github.com/project-minigraf/minigraf-swift", branch: "swift-releases")
// swift-v2.0.0
.package(url: "https://github.com/project-minigraf/minigraf-swift", revision: "1307a095c1725d2813abbbdcf17557311d517d24")
```

Use `git ls-remote --tags https://github.com/project-minigraf/minigraf-swift 'swift-v*'` to
find the commit for another version. New projects should use 2.0.1 or later.

Requires iOS 16+.

## Quick start
Expand Down
Loading
0