From 593046bb25d0effa1bf85d84aca234816b3d3d41 Mon Sep 17 00:00:00 2001 From: Karl Heinz Struggl Date: Fri, 11 Oct 2024 10:54:43 +0200 Subject: [PATCH] replicates Android docs for other mobile sdks --- .../platforms/apple/common/releases/index.mdx | 41 +++++++++++++++++++ docs/platforms/flutter/releases/index.mdx | 41 +++++++++++++++++++ .../platforms/react-native/releases/index.mdx | 41 +++++++++++++++++++ 3 files changed, 123 insertions(+) create mode 100644 docs/platforms/apple/common/releases/index.mdx create mode 100644 docs/platforms/flutter/releases/index.mdx create mode 100644 docs/platforms/react-native/releases/index.mdx diff --git a/docs/platforms/apple/common/releases/index.mdx b/docs/platforms/apple/common/releases/index.mdx new file mode 100644 index 0000000000000..528d8ecd1ff3d --- /dev/null +++ b/docs/platforms/apple/common/releases/index.mdx @@ -0,0 +1,41 @@ +--- +title: Mobile SDK Releases +description: "Learn about Sentry's release channels for Mobile SDK updates." +sidebar_order: 7000 +--- + +The Apple SDK uses the following channels to release SDK updates: + +## `Pre-release` + +Pre-releases (alpha, beta, RC,…) are for larger and potentially more impactful changes, such as new features or major versions. + +## `Latest` + +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. They're intended to be the default for most teams. + +## `Stable` + +Releases are promoted from `Latest` to `Stable` when they've been used in the field for some time and at some scale. The length of time a release has been out, the level of adoption, and other quality and stability metrics are all considered before a release is deemed `Stable`. These types of releases will have a `Stable` label on the releases page. + +## FAQ + +### Where can I find the latest stable release for any given SDK? + +On the releases page of the SDK's GitHub repo. Stable releases will have the `Stable` label in the name of the release. You can also use the search box in the top right to search for the newest releases. + +### Does this mean the release channels are not stable? + +No. Stability and performance are the top priorities for every release. The `Stable` release status means that the release has been tested and proven to work in the wild and at scale. + +### How often do we mark SDKs as stable? + +The stable release cycle depends on a number of factors and can vary, but the target cadence is to provide stable releases roughly every month. + +### Should I only use stable releases? + +We leave this decision up to you. Stable releases have been tested in the field and at significant scale. They are intended for a dependable and consistent experience. Please note that the `Stable` release channel will get our newest features later than other releases. + +### How does this relate to the stability of a feature? + +A `Stable` release status doesn't guarantee the stability of an SDK feature or product feature. A new feature that's still experimental might be part of a stable SDK release. Any experimental features will be clearly marked and offered as an opt-in. diff --git a/docs/platforms/flutter/releases/index.mdx b/docs/platforms/flutter/releases/index.mdx new file mode 100644 index 0000000000000..0a824f3282bf0 --- /dev/null +++ b/docs/platforms/flutter/releases/index.mdx @@ -0,0 +1,41 @@ +--- +title: Mobile SDK Releases +description: "Learn about Sentry's release channels for Mobile SDK updates." +sidebar_order: 7000 +--- + +The Flutter SDK uses the following channels to release SDK updates: + +## `Pre-release` + +Pre-releases (alpha, beta, RC,…) are for larger and potentially more impactful changes, such as new features or major versions. + +## `Latest` + +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. They're intended to be the default for most teams. + +## `Stable` + +Releases are promoted from `Latest` to `Stable` when they've been used in the field for some time and at some scale. The length of time a release has been out, the level of adoption, and other quality and stability metrics are all considered before a release is deemed `Stable`. These types of releases will have a `Stable` label on the releases page. + +## FAQ + +### Where can I find the latest stable release for any given SDK? + +On the releases page of the SDK's GitHub repo. Stable releases will have the `Stable` label in the name of the release. You can also use the search box in the top right to search for the newest releases. + +### Does this mean the release channels are not stable? + +No. Stability and performance are the top priorities for every release. The `Stable` release status means that the release has been tested and proven to work in the wild and at scale. + +### How often do we mark SDKs as stable? + +The stable release cycle depends on a number of factors and can vary, but the target cadence is to provide stable releases roughly every month. + +### Should I only use stable releases? + +We leave this decision up to you. Stable releases have been tested in the field and at significant scale. They are intended for a dependable and consistent experience. Please note that the `Stable` release channel will get our newest features later than other releases. + +### How does this relate to the stability of a feature? + +A `Stable` release status doesn't guarantee the stability of an SDK feature or product feature. A new feature that's still experimental might be part of a stable SDK release. Any experimental features will be clearly marked and offered as an opt-in. diff --git a/docs/platforms/react-native/releases/index.mdx b/docs/platforms/react-native/releases/index.mdx new file mode 100644 index 0000000000000..b3f34c76a39b4 --- /dev/null +++ b/docs/platforms/react-native/releases/index.mdx @@ -0,0 +1,41 @@ +--- +title: Mobile SDK Releases +description: "Learn about Sentry's release channels for Mobile SDK updates." +sidebar_order: 7000 +--- + +The React Native SDK uses the following channels to release SDK updates: + +## `Pre-release` + +Pre-releases (alpha, beta, RC,…) are for larger and potentially more impactful changes, such as new features or major versions. + +## `Latest` + +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. They're intended to be the default for most teams. + +## `Stable` + +Releases are promoted from `Latest` to `Stable` when they've been used in the field for some time and at some scale. The length of time a release has been out, the level of adoption, and other quality and stability metrics are all considered before a release is deemed `Stable`. These types of releases will have a `Stable` label on the releases page. + +## FAQ + +### Where can I find the latest stable release for any given SDK? + +On the releases page of the SDK's GitHub repo. Stable releases will have the `Stable` label in the name of the release. You can also use the search box in the top right to search for the newest releases. + +### Does this mean the release channels are not stable? + +No. Stability and performance are the top priorities for every release. The `Stable` release status means that the release has been tested and proven to work in the wild and at scale. + +### How often do we mark SDKs as stable? + +The stable release cycle depends on a number of factors and can vary, but the target cadence is to provide stable releases roughly every month. + +### Should I only use stable releases? + +We leave this decision up to you. Stable releases have been tested in the field and at significant scale. They are intended for a dependable and consistent experience. Please note that the `Stable` release channel will get our newest features later than other releases. + +### How does this relate to the stability of a feature? + +A `Stable` release status doesn't guarantee the stability of an SDK feature or product feature. A new feature that's still experimental might be part of a stable SDK release. Any experimental features will be clearly marked and offered as an opt-in.