You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Add proper GitHub authentication handling for telemetry
- Add setup_github_authentication() function with interactive prompts
- Handle missing GITHUB_TOKEN gracefully with 3 options:
1. Set GITHUB_TOKEN environment variable
2. Authenticate interactively during autotune
3. Skip telemetry and continue without sharing
- Set up authentication at start of autotune process (before long benchmark)
- Update upload_to_github() to accept pre-authenticated auth object
- Improve error messages and user guidance
- Update tutorial documentation with authentication instructions
- Save results locally as fallback when authentication fails
🤖 Generated with [Claude Code](https://claude.ai/code)
Co-Authored-By: Claude <[email protected]>
Copy file name to clipboardExpand all lines: docs/src/tutorials/autotune.md
+35-2Lines changed: 35 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -306,6 +306,39 @@ By default, autotune results are shared with the LinearSolve.jl community to hel
306
306
- Algorithm performance results
307
307
- NO personal information or sensitive data
308
308
309
-
You can disable this with `telemetry=false` if preferred.
309
+
### GitHub Authentication for Telemetry
310
310
311
-
This helps the community understand performance across different hardware configurations and improves the default algorithm selection for future users.
311
+
When telemetry is enabled, you'll be prompted to authenticate with GitHub:
312
+
313
+
```julia
314
+
# This will prompt for GitHub authentication
315
+
results =autotune_setup(telemetry =true)
316
+
```
317
+
318
+
You have three options:
319
+
320
+
1.**Environment Variable (Recommended)**: Set `GITHUB_TOKEN` before running Julia:
321
+
```bash
322
+
export GITHUB_TOKEN=your_personal_access_token
323
+
julia
324
+
```
325
+
326
+
2.**Interactive Authentication**: Enter your token when prompted during autotune
327
+
328
+
3.**Skip Telemetry**: Choose to continue without sharing results
329
+
330
+
To create a GitHub Personal Access Token:
331
+
1. Go to [GitHub Settings > Tokens](https://github.com/settings/tokens)
332
+
2. Generate a new token with `public_repo` scope
333
+
3. Use it with the autotune process
334
+
335
+
### Disabling Telemetry
336
+
337
+
You can disable telemetry completely:
338
+
339
+
```julia
340
+
# No authentication required
341
+
results =autotune_setup(telemetry =false)
342
+
```
343
+
344
+
This helps the community understand performance across different hardware configurations and improves the default algorithm selection for future users, but participation is entirely optional.
0 commit comments