Skip to content

Commit 1ac8506

Browse files
authored
Add RELEASE.md file (#59)
1 parent 6dcbe7a commit 1ac8506

1 file changed

Lines changed: 15 additions & 0 deletions

File tree

RELEASE.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# PowerSync .NET SDK
2+
3+
## Releasing
4+
5+
1. Ensure all changes you want to release are merged into `main`.
6+
7+
2. Ensure the changelog files for both [Common](./PowerSync/PowerSync.Common/CHANGELOG.md) and [Maui](./PowerSync/PowerSync.Common/CHANGELOG.md) have been updated with _new, well-formatted version numbers._
8+
- The [release workflow](./.github/workflows/release.yml) obtains the version number by searching for the top-most version line (prefixed with `## `), stripping the prefix, and taking the remaining text as the version number. It does this for both changelogs.
9+
- If a release only includes changes to `PowerSync.Common`, don't forget to also update `PowerSync.Maui`'s changelog so that a new release is created that uses the updated version of `PowerSync.Common`.
10+
- By convention, we generally update the changelog within the PRs that add the changes. This sometimes leads to the version number in the changelog being a version ahead of the released version (eg. latest released version is v0.0.3, but changelog has v0.0.4.)
11+
12+
3. Run the `Release` workflow on Github. This will:
13+
- Extract version numbers from the changelogs.
14+
- Create a release for both packages on Nuget.
15+
- Create a Github release containing the changelog contents.

0 commit comments

Comments
 (0)