docs: update credential storage docs and remove stale config.json references#408
Merged
docs: update credential storage docs and remove stale config.json references#408
Conversation
…erences Auth credentials moved to SQLite (cli.db) but several docs pages and code comments still referenced the old ~/.sentry/config.json file. Rewrites the auth command docs with the actual schema, env var precedence, and external access instructions. Fixes stale comments in logout, oauth, and dsn types. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Contributor
Semver Impact of This PR🟢 Patch (bug fixes) 📋 Changelog PreviewThis is how your changes will appear in the changelog. New Features ✨Init
Issue List
Other
Bug Fixes 🐛Init
Other
Documentation 📚
Internal Changes 🔧Init
Other
Other
🤖 This preview updates automatically when you update the PR. |
Contributor
|
Contributor
Codecov Results 📊✅ 104 passed | Total: 104 | Pass Rate: 100% | Execution Time: 0ms 📊 Comparison with Base Branch
✨ No test changes detected All tests are passing successfully. ✅ Patch coverage is 100.00%. Project has 697 uncovered lines. Coverage diff@@ Coverage Diff @@
## main #PR +/-##
==========================================
+ Coverage 96.68% 96.68% —%
==========================================
Files 159 159 —
Lines 21011 21011 —
Branches 0 0 —
==========================================
+ Hits 20314 20314 —
- Misses 697 697 —
- Partials 0 0 —Generated by Codecov Action |
Rename "Reading the Token Externally" to "Direct Database Access" and broaden the framing to orient new users on inspecting stored data rather than just extracting a token. Add expires_at query example. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
BYK
requested changes
Mar 12, 2026
Member
BYK
left a comment
There was a problem hiding this comment.
We should not be documenting our schema or encouraging people to read the db directly. We already have sentry auth token command for this
Users should use `sentry auth token` and `sentry auth status` instead of querying the database directly. Remove the auth table schema, sqlite3 examples, and direct database access encouragement. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
BYK
approved these changes
Mar 12, 2026
SENTRY_TOKEN is the new env var (inspired by GITHUB_TOKEN), while SENTRY_AUTH_TOKEN is the legacy one. The label was on the wrong variable. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Auth credentials were migrated to SQLite (
cli.db) but docs and code comments still referenced~/.sentry/config.json. This updates everything to match reality:cli.dbwith restricted permissions, and points users tosentry auth token/sentry auth statusinstead of exposing the internal schemacli.db, mention WAL permissions, and link to the auth docssqlite3query examples, and "Direct Database Access" subsection — users shouldn't read the DB directlylogout.ts,oauth.ts, anddsn/types.tsTest Plan
bun run typecheck— passes (pre-existing trial module errors only)bun run lint— cleanbun run test:unit— no new failuressqlite3or schema content remains in docs🤖 Generated with Claude Code