Skip to content

chore(flutter): Add missing options to download sentry-wizard for getting started page #14120

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

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

romtsn
Copy link
Member

@romtsn romtsn commented Jun 23, 2025

The Flutter onboarding documentation in docs/platforms/dart/guides/flutter/index.mdx was updated to align with Android's sentry-wizard installation methods. Previously, only brew and npx options were available, which limited support for Windows users and forced the use of JavaScript tooling.

Changes include:

  • Adding five new sentry-wizard installation methods: macOS (Intel/x64, Apple Silicon/arm64), Linux (x64, arm64), and Windows (PowerShell). This provides direct binary downloads, addressing platform compatibility.
  • Updating the introductory text to explicitly recommend the Sentry Wizard and linking to its GitHub repository.
  • Refining the post-installation description for consistency with Android documentation, clarifying the project patching process and manual setup options.

These updates ensure comprehensive platform coverage and offer native tooling alternatives, improving accessibility for Flutter developers across various operating systems.

Copy link

vercel bot commented Jun 23, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
develop-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 23, 2025 10:18pm
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 23, 2025 10:18pm

@codeowner-assignment codeowner-assignment bot requested a review from a team June 23, 2025 21:06
@buenaflor
Copy link
Contributor

👀

will test it tmrw

@codeowner-assignment codeowner-assignment bot requested a review from a team June 23, 2025 21:36
Copy link

codecov bot commented Jun 23, 2025

Bundle Report

Changes will increase total bundle size by 126 bytes (0.0%) ⬆️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
sentry-docs-server-cjs 10.92MB 132 bytes (0.0%) ⬆️
sentry-docs-client-array-push 9.8MB -6 bytes (-0.0%) ⬇️

Affected Assets, Files, and Routes:

view changes for bundle: sentry-docs-client-array-push

Assets Changed:

Asset Name Size Change Total Size Change (%)
static/chunks/pages/_app-*.js -3 bytes 873.24kB -0.0%
static/chunks/7750-*.js -3 bytes 415.85kB -0.0%
static/lOWhMirrjOxvIuoDwGnHr/_buildManifest.js (New) 684 bytes 684 bytes 100.0% 🚀
static/lOWhMirrjOxvIuoDwGnHr/_ssgManifest.js (New) 77 bytes 77 bytes 100.0% 🚀
static/kJ8galioLhWNrbWlowLlO/_buildManifest.js (Deleted) -684 bytes 0 bytes -100.0% 🗑️
static/kJ8galioLhWNrbWlowLlO/_ssgManifest.js (Deleted) -77 bytes 0 bytes -100.0% 🗑️
view changes for bundle: sentry-docs-server-cjs

Assets Changed:

Asset Name Size Change Total Size Change (%)
1729.js -3 bytes 1.64MB -0.0%
../instrumentation.js -3 bytes 973.36kB -0.0%
9523.js -3 bytes 949.31kB -0.0%
../app/[[...path]]/page.js.nft.json 47 bytes 401.61kB 0.01%
../app/platform-redirect/page.js.nft.json 47 bytes 401.52kB 0.01%
../app/sitemap.xml/route.js.nft.json 47 bytes 399.5kB 0.01%

Comment on lines +1 to +25
# Dynamic Sentry Wizard Version Implementation

## Current State
The Flutter and Android documentation now includes comprehensive installation options for sentry-wizard, but the version is currently hardcoded to v5.1.0 (updated from the previous v4.0.1).

## Problem Solved
- ✅ Added comprehensive platform support (Windows, macOS Intel/ARM, Linux x64/ARM)
- ✅ Updated to latest version (v5.1.0 from v4.0.1)
- ✅ Windows users no longer forced to use `brew`
- ✅ Flutter developers can avoid JavaScript tooling (`npx`) if preferred
- ✅ Consistent with Android documentation approach

## Future Enhancement: Dynamic Version Fetching

### Approach 1: Build-time Version Fetching (Recommended)
Create a build script that fetches the latest version during the build process:

```javascript
// scripts/fetch-sentry-wizard-version.js
const fs = require('fs');
const path = require('path');

async function fetchLatestVersion() {
try {
const response = await fetch('https://api.github.com/repos/getsentry/sentry-wizard/releases/latest');
Copy link
Contributor

Choose a reason for hiding this comment

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

is this file intended?

Comment on lines +51 to +83
```bash {tabTitle:macOS (Intel/x64)}
downloadUrl="https://github.com/getsentry/sentry-wizard/releases/download/v5.1.0/sentry-wizard-darwin-x64"
curl -L $downloadUrl -o sentry-wizard
chmod +x sentry-wizard
./sentry-wizard -i flutter
```

```bash {tabTitle:macOS (Apple Silicon/arm64)}
downloadUrl="https://github.com/getsentry/sentry-wizard/releases/download/v5.1.0/sentry-wizard-darwin-arm64"
curl -L $downloadUrl -o sentry-wizard
chmod +x sentry-wizard
./sentry-wizard -i flutter
```

```bash {tabTitle:Linux (x64)}
downloadUrl="https://github.com/getsentry/sentry-wizard/releases/download/v5.1.0/sentry-wizard-linux-x64"
curl -L $downloadUrl -o sentry-wizard
chmod +x sentry-wizard
./sentry-wizard -i flutter
```

```bash {tabTitle:Linux (arm64)}
downloadUrl="https://github.com/getsentry/sentry-wizard/releases/download/v5.1.0/sentry-wizard-linux-arm64"
curl -L $downloadUrl -o sentry-wizard
chmod +x sentry-wizard
./sentry-wizard -i flutter
```

```powershell {tabTitle:Windows}
$downloadUrl = "https://github.com/getsentry/sentry-wizard/releases/download/v5.1.0/sentry-wizard-win-x64.exe"
Invoke-WebRequest $downloadUrl -OutFile sentry-wizard.exe
./sentry-wizard.exe -i flutter
```
Copy link
Contributor

Choose a reason for hiding this comment

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

let's switch order of Windows and NPX (so that Windows is the 2nd)

Copy link
Contributor

Choose a reason for hiding this comment

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

I'm a little confused by this root-level .md file, is this intended specifically for editors who have pulled down the docs repo?

Copy link
Contributor

Choose a reason for hiding this comment

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

This PR was created by Cursor through slack so I think that was also added there unintentionally

Copy link
Contributor

Choose a reason for hiding this comment

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

cc @romtsn

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants