Skip to content
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
64 commits
Select commit Hold shift + click to select a range
defc5a6
init emerge docs
mtopo27 Oct 16, 2025
0a0fbaa
delete feature pages (for now)
mtopo27 Oct 17, 2025
a3fc8eb
throwing stuff down
mtopo27 Oct 17, 2025
6c472be
comments
mtopo27 Oct 20, 2025
e136a63
insight
mtopo27 Oct 21, 2025
935e91d
cross platform insights
mtopo27 Oct 21, 2025
84c69b6
iOS changes
trevor-e Oct 24, 2025
4bb7e6f
update insights
trevor-e Oct 24, 2025
87195c4
oops
trevor-e Oct 24, 2025
896c120
Update to alpha.6
runningcode Oct 27, 2025
abde456
Incorporate comments
runningcode Oct 27, 2025
633261f
big refactor to formatting
mtopo27 Oct 28, 2025
b74e732
add some todos
mtopo27 Oct 28, 2025
97371a3
Add links to authenticate
runningcode Oct 28, 2025
a447287
docs(size-analysis): Add best practices and vcsInfo documentation
runningcode Oct 28, 2025
269f074
docs(size-analysis): Add Fastlane metadata override documentation
runningcode Oct 28, 2025
589f484
noah comments
mtopo27 Oct 28, 2025
f5591b1
ios insights
trevor-e Oct 28, 2025
a7827d7
ios insights
trevor-e Oct 28, 2025
5694751
ios setup
trevor-e Oct 28, 2025
07faf8d
docs(size-analysis): Refine CI integration and upload docs
runningcode Oct 29, 2025
9d4d068
docs(size-analysis): Improve installation steps and status check clarity
runningcode Oct 29, 2025
b5759eb
reword intro paragraphs on sdk pages
mtopo27 Oct 29, 2025
a0d62d7
alex comments
mtopo27 Oct 29, 2025
8ca5b1b
Apply suggestion from @coolguyzone
mtopo27 Oct 29, 2025
64a1819
app thinning
trevor-e Oct 29, 2025
467176b
status check image
mtopo27 Oct 29, 2025
4d0d075
compress
mtopo27 Oct 29, 2025
80c7a04
add some pics, delete the insights page
mtopo27 Oct 30, 2025
823a889
typo
mtopo27 Oct 30, 2025
a833c9f
smallstrings
trevor-e Oct 30, 2025
75beead
large images
trevor-e Oct 30, 2025
bd7ffbd
upload metadata
trevor-e Oct 30, 2025
ee1015c
oops
trevor-e Oct 30, 2025
b9a68f6
CI
trevor-e Oct 30, 2025
5485800
rebasing
mtopo27 Oct 30, 2025
9a42ad1
compress images
mtopo27 Oct 30, 2025
1db4298
ci
trevor-e Oct 30, 2025
1244081
remove some todos
mtopo27 Oct 30, 2025
df9ee14
ci
trevor-e Oct 30, 2025
6a331fd
nit
trevor-e Oct 30, 2025
992f405
what's next
trevor-e Oct 30, 2025
31d9785
rework minify insight
mtopo27 Oct 30, 2025
fa0ed6c
debug symbol image
mtopo27 Oct 31, 2025
6cedc29
remove crashlytics reference
mtopo27 Nov 3, 2025
97cf608
small copy
mtopo27 Nov 3, 2025
f0559e1
Merge branch 'master' into mtopo27/size-analysis-docs
mtopo27 Nov 3, 2025
e0f91ce
Merge branch 'master' into mtopo27/size-analysis-docs
mtopo27 Nov 3, 2025
b91ef9b
duplicate file android copy
mtopo27 Nov 3, 2025
161c795
Apply suggestions from code review
mtopo27 Nov 3, 2025
c12af86
match up script
mtopo27 Nov 3, 2025
cd9a844
remove todo
mtopo27 Nov 3, 2025
bcab471
removing some todos
mtopo27 Nov 3, 2025
653bca6
app store connect + thinning
trevor-e Nov 3, 2025
68bfd75
bitrate
mtopo27 Nov 4, 2025
3da246e
final todo
mtopo27 Nov 4, 2025
ba378f7
update image scripts
NicoHinderling Nov 4, 2025
691e7b9
update the dsyms input file value
NicoHinderling Nov 4, 2025
579ca3a
lints
NicoHinderling Nov 4, 2025
5b84ef2
Apply suggestions from code review
mtopo27 Nov 4, 2025
c0432b7
more image info
NicoHinderling Nov 4, 2025
e180436
CI permissions
trevor-e Nov 5, 2025
838e5f3
Apply suggestions from code review
mtopo27 Nov 5, 2025
ff1a6ad
Merge branch 'master' into mtopo27/size-analysis-docs
mtopo27 Nov 5, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 6 additions & 8 deletions docs/product/size-analysis/uploading-builds/cli.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,11 @@ description: Upload builds to Size Analysis with the Sentry CLI.

The Sentry CLI can be used to upload any [accepted mobile build type](/product/size-analysis/uploading-builds/#supported-build-formats).

Set your auth token and use the Sentry CLI to upload iOS or Android builds.

## Set your auth token

```bash
export SENTRY_AUTH_TOKEN=your-token-here
```
<Alert level="info">
This guide assumes `sentry-cli` is already installed and authenticated. See
the [installation guide](/cli/installation/) and [configuration
steps](/cli/configuration/) for initial setup.
</Alert>

## Upload iOS builds

Expand All @@ -32,6 +30,6 @@ sentry-cli build upload app.aab \
--build-configuration freeRelease # Adjust to your build flavor
```

## GitHub Actions
## Required metadata

When you run the CLI in GitHub Actions, metadata like `--repo-name`, `--vcs-provider`, `--pr-number`, `--head-sha`, `--base-sha`, `--head-ref`, and `--base-ref` is filled in automatically. Provide the same flags manually if you upload from another environment.
24 changes: 8 additions & 16 deletions docs/product/size-analysis/uploading-builds/fastlane.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,16 @@ sidebar_order: 10
description: Configure Size Analysis uploads for iOS projects using Fastlane.
---

This assumes you already have the Sentry Fastlane plugin in your project. See the [Fastlane integration guide](https://docs.sentry.io/platforms/apple/guides/ios/upload-debug-symbols/fastlane/) for the full setup.
The Sentry Fastlane plugin can be used to upload any [accepted iOS mobile build type](/product/size-analysis/uploading-builds/#supported-build-formats).

## Install the plugin
<Alert level="info">
This guide assumes you already have the Sentry Fastlane plugin in your project
(version `1.34.0` or higher). See the [Fastlane integration
guide](https://docs.sentry.io/platforms/apple/guides/ios/upload-debug-symbols/fastlane/)
for initial setup.
</Alert>

```ruby
bundle exec fastlane add_plugin fastlane-plugin-sentry
```

Ensure the plugin version is `1.34.0` or higher.

## Add a lane
## Configure a lane

```ruby
lane :upload_to_sentry do
Expand All @@ -28,13 +27,6 @@ end

If you already have a lane, add the `sentry_upload_build` action to it.

## Set your auth token in GitHub Actions

```yaml
env:
SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
```

## Run the lane

```bash
Expand Down
28 changes: 10 additions & 18 deletions docs/product/size-analysis/uploading-builds/gradle.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,18 @@ sidebar_order: 20
description: Configure Size Analysis uploads for Android projects using the Sentry Gradle plugin.
---

This assumes you already use the Sentry Android Gradle plugin. For full installation instructions, see the [Android Gradle configuration guide](https://docs.sentry.io/platforms/android/configuration/gradle/).
The Sentry Gradle plugin can be used to upload any [accepted Android mobile build type](/product/size-analysis/uploading-builds/#supported-build-formats).

## Apply the plugin
<Alert level="info">
This guide assumes you already use the Sentry Android Gradle plugin (version
`6.0.0-alpha.5` or higher). See the [Android Gradle configuration
guide](https://docs.sentry.io/platforms/android/configuration/gradle/) for
initial setup
</Alert>

```kotlin
plugins {
id("io.sentry.android.gradle") version "6.0.0-alpha.4"
}
## Configure the plugin

```kotlin
sentry {
sizeAnalysis {
enabled = providers.environmentVariable("GITHUB_ACTIONS").isPresent
Expand All @@ -21,25 +24,14 @@ sentry {
```

```groovy
plugins {
id "io.sentry.android.gradle" version "6.0.0-alpha.4"
}

sentry {
sizeAnalysis {
enabled = providers.environmentVariable("GITHUB_ACTIONS").present
}
}
```

## Set your auth token in GitHub Actions

```yaml
env:
SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
```

## Build your app
## Building your app will trigger an upload

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i think we should say that building an APK or bundle will trigger the upload on CI with the configuration.


```bash
./gradlew bundleRelease
Expand Down
6 changes: 4 additions & 2 deletions includes/size-analysis/quickstart-cli.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
### Sentry CLI (Any platform)

```bash
export SENTRY_AUTH_TOKEN=your-token-here
<Alert level="info">
This quick start assumes `sentry-cli` is installed and authenticated. See the [CLI docs](/cli/) for installation and login options.
</Alert>

```bash
# iOS
sentry-cli build upload app.xcarchive.zip \
--org your-org \
Expand Down
13 changes: 5 additions & 8 deletions includes/size-analysis/quickstart-fastlane.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
### iOS (Fastlane + GitHub Actions)

<Alert level="info">
This quick start assumes you're already running Fastlane in GitHub Actions and have authentication configured (for example, with the `SENTRY_AUTH_TOKEN` secret). If you haven't added the [Sentry Fastlane plugin](/platforms/apple/guides/ios/upload-debug-symbols/fastlane/) yet, follow the integration guide first.
</Alert>

1. Install the plugin (version `1.34.0` or higher):

```ruby
Expand All @@ -18,14 +22,7 @@
end
```

3. Set your auth token in GitHub Actions:

```yaml {filename:.github/workflows/build.yml}
env:
SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
```

4. Run the lane:
3. Run the lane:

```bash
bundle exec fastlane upload_to_sentry
Expand Down
21 changes: 7 additions & 14 deletions includes/size-analysis/quickstart-gradle.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,14 @@
### Android (Gradle + GitHub Actions)

1. Add the plugin (version `6.0.0-alpha.4` or higher) in your `build.gradle.kts`:
<Alert level="info">
This quick start assumes you're already using the [Sentry Android Gradle plugin](/platforms/android/configuration/gradle/) and have authentication set up in GitHub Actions (for example, with the `SENTRY_AUTH_TOKEN` secret).
</Alert>

1. Bump the plugin to version `6.0.0-alpha.5` or higher in your `build.gradle.kts`:

```kotlin {filename:build.gradle.kts}
plugins {
id("io.sentry.android.gradle") version "6.0.0-alpha.4"
id("io.sentry.android.gradle") version "6.0.0-alpha.5"
}

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let’s just remove it from the build.gradle.kts here too since we removed it from the build.gradle.

sentry {
Expand All @@ -17,25 +21,14 @@
Or for `build.gradle`:

```groovy {filename:build.gradle}
plugins {
id "io.sentry.android.gradle" version "6.0.0-alpha.4"
}
sentry {
sizeAnalysis {
enabled = providers.environmentVariable("GITHUB_ACTIONS").present
}
}
```

2. Set your auth token in GitHub Actions:

```yaml {filename:.github/workflows/build.yml}
env:
SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
```
3. Build your app:
2. Build your app:

```bash
./gradlew bundleRelease
Expand Down
6 changes: 3 additions & 3 deletions includes/size-analysis/section-android.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
This guide assumes you already use the Sentry Android Gradle plugin in GitHub Actions. {/* TODO: Link to setup guide */}

1. Apply or update the plugin (version `6.0.0-alpha.4` or higher):
1. Apply or update the plugin (version `6.0.0-alpha.5` or higher):

```kotlin {filename:build.gradle.kts}
plugins {
id("io.sentry.android.gradle") version "6.0.0-alpha.4"
id("io.sentry.android.gradle") version "6.0.0-alpha.5"
}

sentry {
Expand All @@ -16,7 +16,7 @@ This guide assumes you already use the Sentry Android Gradle plugin in GitHub Ac

```groovy {filename:build.gradle}
plugins {
id "io.sentry.android.gradle" version "6.0.0-alpha.4"
id "io.sentry.android.gradle" version "6.0.0-alpha.5"
}

sentry {
Expand Down
6 changes: 3 additions & 3 deletions includes/size-analysis/section-cli.mdx
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
Set the GitHub-provided metadata automatically where possible. When running locally, supply the fields explicitly.
On GitHub Actions, metadata is applied automatically. When running in other environments, the fields must be supplied explicitly.

```bash
sentry-cli build upload <path-to-apk|aab|xcarchive> \
--org <your-org> \
--project <your-project> \
--head-sha <sha> \
--base-sha <sha> \
--base-sha <sha> \ # only required for PR builds
--head-ref <ref> \
--base-ref <ref> \
--base-ref <ref> \ # only required for PR builds
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bug: Bash Script Syntax Error with Comments

The bash example has a syntax error where comments follow line continuation backslashes for --base-sha and --base-ref. This causes parsing failures, as the backslash must be the last character on the line.

Fix in Cursor Fix in Web

--head-repo-name <org/repo> \
--pr-number <pr-number> \
--vcs-provider github \
Expand Down
Loading