From 00dbcc43a289b1508b2acb3d3596efa928a1e3a2 Mon Sep 17 00:00:00 2001 From: DominicGBauer Date: Fri, 7 Feb 2025 15:50:00 +0200 Subject: [PATCH 1/2] docs: add release guide --- docs/Release.md | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 docs/Release.md diff --git a/docs/Release.md b/docs/Release.md new file mode 100644 index 0000000..a4c9871 --- /dev/null +++ b/docs/Release.md @@ -0,0 +1,7 @@ +# PowerSync Swift SDK + +## Releasing +* Confirm every PR you want in the release has been merged into `main`. +* Update `CHANGELOG.md` with the changes. +* In GitHub actions on GitHub manually run the `Release PowerSync` action. You will be required to update the version and add release notes. +* 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. From affa351a2fe4eaea3459cf2fcd9f7752e9e42334 Mon Sep 17 00:00:00 2001 From: DominicGBauer Date: Fri, 7 Feb 2025 16:16:34 +0200 Subject: [PATCH 2/2] docs: add local build guide --- docs/LocalBuild.md | 12 ++++++++++++ docs/Release.md | 1 + 2 files changed, 13 insertions(+) create mode 100644 docs/LocalBuild.md diff --git a/docs/LocalBuild.md b/docs/LocalBuild.md new file mode 100644 index 0000000..1657062 --- /dev/null +++ b/docs/LocalBuild.md @@ -0,0 +1,12 @@ +# PowerSync Swift SDK + +## Run against a local kotlin build + +* To run using the local kotlin build you need to apply the following change in the `Package.swift` file: + + ```swift + dependencies: [ + .package(url: "https://github.com/powersync-ja/powersync-kotlin.git", exact: "x.y.z"), <-- Comment this + // .package(path: "../powersync-kotlin"), <-- Include this line and put in the path to you powersync-kotlin repo + ``` +* 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. diff --git a/docs/Release.md b/docs/Release.md index a4c9871..ecde131 100644 --- a/docs/Release.md +++ b/docs/Release.md @@ -1,6 +1,7 @@ # PowerSync Swift SDK ## Releasing + * Confirm every PR you want in the release has been merged into `main`. * Update `CHANGELOG.md` with the changes. * In GitHub actions on GitHub manually run the `Release PowerSync` action. You will be required to update the version and add release notes.