Skip to content

Commit 3afda29

Browse files
docs: add release guide (#18)
* docs: add release guide * docs: add local build guide
1 parent 566c924 commit 3afda29

File tree

2 files changed

+20
-0
lines changed

2 files changed

+20
-0
lines changed

docs/LocalBuild.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# PowerSync Swift SDK
2+
3+
## Run against a local kotlin build
4+
5+
* To run using the local kotlin build you need to apply the following change in the `Package.swift` file:
6+
7+
```swift
8+
dependencies: [
9+
.package(url: "https://github.com/powersync-ja/powersync-kotlin.git", exact: "x.y.z"), <-- Comment this
10+
// .package(path: "../powersync-kotlin"), <-- Include this line and put in the path to you powersync-kotlin repo
11+
```
12+
* To quickly make a local build to apply changes you made in `powersync-kotlin` for local development in the Swift SDK run the gradle task `spmDevBuild` in `PowerSyncKotlin` in the `powersync-kotlin` repo. This will update the files and the changes will be reflected in the Swift SDK.

docs/Release.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# PowerSync Swift SDK
2+
3+
## Releasing
4+
5+
* Confirm every PR you want in the release has been merged into `main`.
6+
* Update `CHANGELOG.md` with the changes.
7+
* In GitHub actions on GitHub manually run the `Release PowerSync` action. You will be required to update the version and add release notes.
8+
* If the release notes are complicated and don't fit on a single line it is easier to rather update those after the release is completed by updating the release notes in the new release.

0 commit comments

Comments
 (0)