Skip to content

Commit ebc913b

Browse files
itsmeadicursoragent
andcommitted
docs(release): document auto and manual release paths
Add a concise release process section describing PR-title semver rules and the manual fallback workflow. Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent ba799cd commit ebc913b

1 file changed

Lines changed: 15 additions & 0 deletions

File tree

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,3 +63,18 @@ We've recently closed a [$38 million Series B funding round](https://techcrunch.
6363
Our APIs are used by more than a billion end-users, and you'll have a chance to make a huge impact on the product within a team of the strongest engineers all over the world.
6464

6565
Check out our current openings and apply via [Stream's website](https://getstream.io/team/#jobs).
66+
67+
## Release Process
68+
69+
Releases use two paths:
70+
71+
- Default: automatic release when a PR is merged to `main`.
72+
- Fallback: manual release using `.github/workflows/manual-release.yml` (admin use only).
73+
74+
Automatic semver bump rules are based on merged PR title/body:
75+
76+
- `feat:` -> minor
77+
- `fix:` (or `bug:`) -> patch
78+
- `feat!:` or `BREAKING CHANGE` in PR body -> major
79+
80+
PRs with other prefixes do not trigger a release.

0 commit comments

Comments
 (0)