-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
docs(build-distribution): Add Install Groups documentation #16529
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
60 changes: 60 additions & 0 deletions
60
docs/platforms/android/build-distribution/install-groups.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| --- | ||
| title: Install Groups | ||
| sidebar_order: 20 | ||
| description: Control which Android builds can see updates for each other using install groups. | ||
| --- | ||
|
|
||
| <Include name="feature-available-for-user-group-early-adopter" /> | ||
|
|
||
| Install groups let you tag builds with one or more group names to control update visibility between builds. See the [product documentation](/product/build-distribution/#install-groups) for a full explanation of how install groups work. | ||
|
|
||
| ## Uploading With Install Groups | ||
|
|
||
| ### Sentry CLI | ||
|
|
||
| Pass `--install-group` one or more times: | ||
|
|
||
| ```bash | ||
| sentry-cli build upload app.apk \ | ||
| --org your-org \ | ||
| --project your-project \ | ||
| --build-configuration Release \ | ||
| --install-group alpha \ | ||
| --install-group staging | ||
| ``` | ||
|
|
||
| ### Gradle Plugin | ||
|
|
||
| Set `installGroups` in the `distribution` block: | ||
|
|
||
| ```kotlin {filename:build.gradle.kts} | ||
| sentry { | ||
| distribution { | ||
| enabled = true | ||
| installGroups.set(setOf("alpha", "staging")) | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ```groovy {filename:build.gradle} | ||
| sentry { | ||
| distribution { | ||
| enabled = true | ||
| installGroups = ["alpha", "staging"] | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ### Fastlane Plugin | ||
|
|
||
| Pass the `install_groups` parameter: | ||
|
|
||
| ```ruby {filename:Fastfile} | ||
| sentry_upload_build( | ||
| org_slug: 'your-org', | ||
| project_slug: 'your-project', | ||
| apk_path: 'path/to/app.apk', | ||
| build_configuration: 'Release', | ||
| install_groups: ['alpha', 'staging'] | ||
| ) | ||
| ``` |
38 changes: 38 additions & 0 deletions
38
docs/platforms/apple/guides/ios/build-distribution/install-groups.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| --- | ||
| title: Install Groups | ||
| sidebar_order: 20 | ||
| description: Control which iOS builds can see updates for each other using install groups. | ||
| --- | ||
|
|
||
| <Include name="feature-available-for-user-group-early-adopter" /> | ||
|
|
||
| Install groups let you tag builds with one or more group names to control update visibility between builds. See the [product documentation](/product/build-distribution/#install-groups) for a full explanation of how install groups work. | ||
|
|
||
| ## Uploading With Install Groups | ||
|
|
||
| ### Sentry CLI | ||
|
|
||
| Pass `--install-group` one or more times: | ||
|
|
||
| ```bash | ||
| sentry-cli build upload app.xcarchive \ | ||
| --org your-org \ | ||
| --project your-project \ | ||
| --build-configuration Release \ | ||
| --install-group alpha \ | ||
| --install-group staging | ||
| ``` | ||
|
|
||
| ### Fastlane Plugin | ||
|
|
||
| Pass the `install_groups` parameter: | ||
|
|
||
| ```ruby {filename:Fastfile} | ||
| sentry_upload_build( | ||
| org_slug: 'your-org', | ||
| project_slug: 'your-project', | ||
| xcarchive_path: 'path/to/YourApp.xcarchive', | ||
| build_configuration: 'Release', | ||
| install_groups: ['alpha', 'staging'] | ||
| ) | ||
| ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Bug: The documentation states users can provide install groups when checking for updates, but the Android and iOS SDK examples show no such parameter, creating a contradiction.
Severity: MEDIUM
Suggested Fix
Align the documentation with the actual SDK functionality. If the SDKs support passing install groups, update the Android and iOS documentation and code examples to show how. If they do not, remove the statement from
docs/product/build-distribution/index.mdxthat claims users can provide install groups when checking for updates.Prompt for AI Agent
Did we get this right? 👍 / 👎 to inform future reviews.