Skip to content

docs(build-distribution): Add Install Groups documentation#16529

Merged
runningcode merged 3 commits intomasterfrom
no/install-groups-docs
Feb 26, 2026
Merged

docs(build-distribution): Add Install Groups documentation#16529
runningcode merged 3 commits intomasterfrom
no/install-groups-docs

Conversation

@runningcode
Copy link
Copy Markdown
Contributor

@runningcode runningcode commented Feb 23, 2026

DESCRIBE YOUR PR

Add documentation for the new Install Groups feature in Build Distribution. Install groups let users tag builds with group names to control which builds are offered as over-the-air updates.

  • Add product-level docs explaining install groups concept, OR-matching logic, and use cases
  • Add Android platform guide covering CLI, Gradle plugin, and Fastlane plugin setup
  • Add iOS platform guide covering CLI and Fastlane plugin setup
  • Update upload metadata table with install-group field

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.

  • Urgent deadline (GA date, etc.):
  • Other deadline:
  • None: Not urgent, can wait up to 1 week+

SLA

  • Teamwork makes the dream work, so please add a reviewer to your PRs.
  • Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it.
    Thanks in advance for your help!

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

EME-864

Co-Authored-By: Claude noreply@anthropic.com

Add documentation for the Install Groups feature which lets users
tag builds with group names to control update visibility. Includes
platform-specific guides for Android (CLI, Gradle, Fastlane) and
iOS (CLI, Fastlane), product-level explanation, and upload metadata
table update.

Co-Authored-By: Claude <noreply@anthropic.com>
@vercel
Copy link
Copy Markdown

vercel Bot commented Feb 23, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
sentry-docs Ready Ready Preview, Comment Feb 26, 2026 5:02pm
1 Skipped Deployment
Project Deployment Actions Updated (UTC)
develop-docs Ignored Ignored Preview Feb 26, 2026 5:02pm

Request Review

Comment thread docs/product/build-distribution/index.mdx Outdated
Comment thread docs/product/build-distribution/index.mdx Outdated
Instead of referencing the "currently installed build", describe
install groups as a list provided by the caller when checking for
updates. This is more accurate since there is no reliable way to
automatically detect the current build across platforms.

Co-Authored-By: Claude <noreply@anthropic.com>
Comment thread docs/product/build-distribution/index.mdx Outdated
Comment thread docs/product/build-distribution/index.mdx Outdated
Simplify "How It Works" section per review feedback: remove the
numbered list about app/build configuration (which doesn't reflect
actual behavior) and reframe matching as set intersection rather
than OR logic.

Co-Authored-By: Claude <noreply@anthropic.com>
@runningcode runningcode enabled auto-merge (squash) February 26, 2026 16:55
Comment on lines +38 to +40
Matching requires two builds to have a non-empty intersection of their install groups. For example, a build tagged `["alpha", "staging"]` will see updates from a build tagged `["alpha", "beta"]` because both share `alpha`.

### Use Cases
Copy link
Copy Markdown

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.mdx that claims users can provide install groups when checking for updates.

Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent.
Verify if this is a real issue. If it is, propose a fix; if not, explain why it's not
valid.

Location: docs/product/build-distribution/index.mdx#L38-L40

Potential issue: The product documentation at
`docs/product/build-distribution/index.mdx` states that when a device checks for
updates, a developer "can provide a list of install groups". However, the corresponding
SDK documentation for both Android and iOS does not show a way to pass this list. The
Android example uses `checkForUpdateBlocking()` with no parameters, and the iOS
`CheckForUpdateParams` object does not include a field for install groups. This
discrepancy will lead developers to believe a feature is available when the SDKs do not
expose it, causing confusion and incorrect implementation attempts.

Did we get this right? 👍 / 👎 to inform future reviews.

@runningcode runningcode merged commit 46ae798 into master Feb 26, 2026
17 checks passed
@runningcode runningcode deleted the no/install-groups-docs branch February 26, 2026 17:06
@github-actions github-actions Bot locked and limited conversation to collaborators Mar 14, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants