Skip to content

Commit

Permalink
Add release checklist
Browse files Browse the repository at this point in the history
  • Loading branch information
ianthetechie committed Oct 29, 2023
1 parent e2c4527 commit cccbbbe
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 3 deletions.
4 changes: 1 addition & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ and install targets automatically.
xcode-select --install
```

* Since you're developing locally, set `let useLocalFramework = true` in `Package.swift`.
* Run the iOS build script

```shell
Expand All @@ -71,9 +72,6 @@ Further, the "normal" Xcode build flow always assumes xcframeworks can't change
so it processes them before any other build rules.
Given these limitations, we opted for a shell script until further notice.

If Xcode is not behaving well,
a quick restart of Xcode or resetting the package graph usually clears it up.

### Android

NOTE: Android is probably broken at the moment!
Expand Down
10 changes: 10 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Cutting a release

When cutting a release, follow this checklist:

1. Ensure that all version strings are up to date.
Currently this means checking crate and Swift package versions.
2. Generate the iOS framework using `build-ios.sh --release`.
This updates Package.swift and generates a distributable zipped framework under `common/target/ios`.
3. Create a GitHub release.
Upload the zipped XCFramework along with the GitHub release.

0 comments on commit cccbbbe

Please sign in to comment.