Skip to content

Commit 90ea84e

Browse files
authored
update release flow docs (#390)
1 parent c956220 commit 90ea84e

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

+15
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,21 @@ App SDK is in the early stage at the moment. Every API below 1.x.x release is li
2121

2222
Feel free to play with SDK and move its code directly to your app.
2323

24+
## Release flow
25+
26+
- The `main` branch is a current, latest branch.
27+
- Branches matching `v[0-9]+.x` (like `v1.x`, v0.x`) are release branches
28+
- PRs should be opened to `main` branch and contain changesets (run `npx changeset`). Once changeset is merged to main, the release PR is opened. After the release PR is merged, the version is being pushed to NPM and changesets are pruned
29+
- To patch older version, commit from `main` (including changeset) should be also ported to release branch (e.g. v0.x). Release branch will also detect changes and open release PR
30+
- To release new major version (e.g. start working on `v2.x` from `v1.x`):
31+
- Create a legacy release branch (e.g. `v1.x` branch)
32+
- Mark changeset to `main` with `major` change, which will start counting next `main` releases as `2.x.x`
33+
- Do not merge release PR until it's ready to be merged
34+
35+
### Deploying test snapshots
36+
37+
PRs can be pushed to NPM by adding label to PR `release dev tag`. Workflow will run and print version that has been released.
38+
2439
## Installing
2540

2641
```bash

0 commit comments

Comments
 (0)