Skip to content

Commit 62630e6

Browse files
committed
Upload release instructions
1 parent 43b31a1 commit 62630e6

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

docs/Release.md

+10-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,15 @@
22

33
## How to make a release
44

5-
1. Update `LIBRARY_VERSION` and `SWIFT_LIBRARY_VERSION` in `gradle.properties` in the root.
5+
1. Update `LIBRARY_VERSION` in `gradle.properties` in the root.
66
2. Add an entry to the `CHANGELOG.md`.
77
3. Make a PR and merge it.
8-
4. Once the PR is merged and in the `main` branch then manually run the Github action `Deploy to Sonatype`. This will create a release to Maven Central and will also update the version of the `powersync-kotlin` SPM package used in the Swift SDK. If the release contains changes pertaining to the Swift SDK you will need to update the `powersync-kotlin` SPM package version in that repo and make a release there as well.
8+
4. Pull `main` (which now contains your merged PR) and create a tag matching the version, e.g.
9+
`git tag v1.1.0`.
10+
5. Push that tag and manually trigger the GitHub action `Release` on that tag. This will:
11+
- Create a release to Maven Central.
12+
- Create a draft release on Github.
13+
- Attach a prebuild `XCFramework` zip-archive for the Swift SDK to the draft release.
14+
6. Copy relevant entries from the changelog into the draft release and make it public!
15+
7. To apply this release to the Swift SDK, update the `Package.swift` file to point at the framework
16+
from that release. You can copy the SHA256 hashsum from the generated draft release notes.

0 commit comments

Comments
 (0)