Skip to content

Commit 51a97b2

Browse files
author
Karl Heinz Struggl
committed
first draft of release process page
1 parent 71c7bed commit 51a97b2

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
title: Release Channels
3+
description: "Learn about the SDK's release channels and choose the right one."
4+
sidebar_order: 7000
5+
---
6+
7+
This SDK uses the following ways to release SDK updates:
8+
9+
## `Pre-release`
10+
11+
We create pre-releases (alpha, beta, RC,…) for larger and potentially more impactful changes, such as new features or major versions.
12+
13+
## `Latest`
14+
15+
We continuously release major/minor/hotfix versions from the `main` branch. These releases go through all our internal quality gates and are very safe to use and intended to be the default for most teams.
16+
17+
## `Stable`
18+
19+
We promote releases from `Latest` when they have been used in the field for some time and in scale, considering time since release, adoption, and other quality and stability metrics. These releases will be indicated on the releases page (https://github.com/getsentry/sentry-cocoa/releases/) with the `Stable` suffix.
20+
21+
## FAQ
22+
23+
### Where can I find the latest stable release for any given SDK?
24+
25+
On the releases pages of the SDK's GitHub repo. Stable releases will be indicated with the suffix `(Stable)` in the name of the release. You can also use the search box in the top right, and you will see the newest matching releases.
26+
27+
### Does this mean our other releases are not stable?
28+
29+
No. Stability and performance are the top priorities for every release. The `Stable` release channel is specifically designed as an additional way to build on that by utilising the fact that releases are proven in the wild an in large scale.
30+
31+
### How often do we mark SDKs as stable?
32+
33+
The target cadence is to provide monthly stable releases.
34+
35+
### Should every customer only use stable releases?
36+
37+
Every developer, team and company knows best which release channel works for them. As stated earlier, every release is considered stable, but `Stable` releases provide an extra layer of safety to make sure the SDK is working as expected, with the tradeoff of a slightly delayed availability. This is also the reason why it's there isn't a pre-release for every release.
38+
39+
### How does this relate to the release process and stability of a feature?
40+
41+
This process is independent of stability of an individual feature and does not change the way features are rolled out. For example, a stable SDK release might still include a new feature that is marked experimental.

0 commit comments

Comments
 (0)