Skip to content

add the sentry sdk changelog sources - #229

Open
adssib wants to merge 3 commits into
pl4-changelog-stripefrom
pl4-changelog-sentry
Open

adssib wants to merge 3 commits into
pl4-changelog-stripefrom
pl4-changelog-sentry

Conversation

@adssib

@adssib adssib commented Nov 21, 2026 •

Copy link
Copy Markdown
Contributor

Stacked on #227.

What this changes

Registers Sentry's SDK changelogs under the existing sentry provider: sentry/python-changelog (pypi:sentry-sdk), sentry/javascript-changelog (npm:@sentry/node, npm:@sentry/browser), sentry/go (go:github.com/getsentry/sentry-go), sentry/dotnet (nuget:Sentry). The audit's sentry/python and sentry/javascript migration guides are not added: the Python 2.0 changelog section carries the guide's own Removed/Deprecated lists (a guide source would repeat the same events under another id), and the JavaScript guide's headings are mostly options and behavior (no plain removals to read without false positives).

Kind changelog; versions from the registry or the repo's tags (no pins); each release read at its tag.

Checklist

  • Metadata complete in the registration (provider metadata matches its other kinds' registrations; each source's id, layer, watches, URL, packages, page), and I read the words
  • Every commit is signed off (git commit -s, DCO)
  • Golden test over a real saved copy of the source: python 1.45.1→2.0.0 (8 events), javascript 9.47.2→10.0.0 (2), go 0.30.0→0.31.0 (1), dotnet 3.41.4→4.0.0 (2)
  • testdata/README.md lists each file: URL, tag commit, date fetched, license, quote
  • One pinned drop test per source: another real release in the same saved file that must produce no event
  • providers/sentry-sdks.md written from providers/_template.md, including Why this source
  • Fetches only through env.Get
  • make check passes locally (make plugins prints the sources as expected)
  • Nothing private

Notes for the reviewer

Saved changelogs are trimmed to two releases' sections (the golden's and the drop test's), each unchanged; only the pinned release's section is read, so the events are the same as from the whole file. Each pinned pair's previous_version is the release before on the registry or tag list (checked live on 2026-11-20).

Refs #194 (not closing: other sources in the story are other kinds).

Related PRs

Combined into main: #232 (stack #227 → #228 → #229 → #230 → #231).

🤖 Generated with Claude Code

Co-Authored-By: Claude Opus 5.5 <[email protected]>
Signed-off-by: adssib <[email protected]>
@claude

claude Bot commented Nov 21, 2026 •

Copy link
Copy Markdown

Claude finished @adssib's task in 1m 59s —— View job


⚠️ Merge after fixes. The registration, page, tests and sources are in good shape, but two events need another look before they can open pull requests in someone's repo: a file name emitted as a symbol (Python) and @sentry/core removals filed under @sentry/node (JavaScript).

Rules

Rule Status Evidence
Metadata in the registration (Rule 1) ✅ plugins/changelog/sentry.go:7 uses the same name, category and homepage as plugins/openapi/openapi.go:121, so RegisterProvider merges them without panicking. Each source gets its id, layer, watches, URL, packages and page from sdk(). No hand-kept list was added.
Provider page ✅ providers/sentry-sdks.md has Why this source with the links, the date checked (2026-11-20), why this source, the alternatives not used and a quote.
Golden test + quote ✅ (see bugs) Four goldens match the saved changelogs. testdata/README.md has one row per file with the URL, tag commit, date, MIT license, quote and a note on the trimming. Every event carries source_url (the raw file at its tag) and source_excerpt.
Drop test ✅ Python 1.45.0, JavaScript 9.40.0, Go 0.30.0 and .NET 3.41.4, each a real section in the same saved file.
Fetch only via env ✅ No new fetch code: ReadAt and ListVersions in changelog.go go through env.Get.
Nothing private (Rule 2) ✅ The leak guard is clean. The DSN in the .NET fixture (line 75) is upstream's own fake-sentry.io placeholder. The commit is signed off.

Bugs

  1. tracing_utils_py2.py emitted as a removed symbol (golden/sentry-python-changelog.json:88). It's a file name, so nothing downstream will match it against an import. It was also a Python‑2‑only internal module, and 2.0.0 drops Python 2. I suggest having classify.go reject code spans with a file extension and regenerating the golden (7 events). Details in the inline comment.
  2. JavaScript events may name the wrong package (golden/sentry-javascript-changelog.json). BaseClient and hasTracingEnabled are feat(core)! removals from @sentry/core, but these events say @sentry/node, and npm:@sentry/browser is registered but never carried by any event. Please check whether @sentry/[email protected] exported these two names. If it didn't, fix the attribution, either by covering @sentry/core and setting the package from the scope, or by dropping (core)! bullets. Details in the inline comment.

Verified

  • go build ./...: passed
  • go vet ./...: passed
  • gofmt -l .: printed nothing
  • go test -race ./...: every package passed, including plugins/changelog (goldens, drop tests, registration)
  • python3 scripts/leak_guard.py --all: "no banned terms (8 hashed terms checked)"
  • Not run: make check and go run ./cmd/list-plugins both needed approval in this runner, so I didn't check the make plugins output myself.

Non-blocking

  • The source ids are uneven: python-changelog and javascript-changelog, but plain go and dotnet. I'm guessing the -changelog suffix keeps sentry/python and sentry/javascript free for possible migration-guide sources. A sentence on the provider page saying so would help readers.
  • The pairs are ordered by version, so 2.0.0's previous_version is 1.45.1 even though 1.45.1 came out after 2.0.0. That's how the kit works and it's fine; it might just be worth one line under "Notes for the reviewer".
  • Recall is low on these majors: for example, .NET's "Class renamed Sentry.User to Sentry.SentryUser" and Python's "Removed last_event_id() top level API" are dropped. That's the right trade under precision over recall; this is only a possible follow-up for the classifier.

Thanks for the careful trimming notes and the per-file README rows. They made this easy to check against the sources.

"package": "sentry-sdk",
"change": "removed_symbol",
"symbols": [
"tracing_utils_py2.py"

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Wrong symbol in this event. tracing_utils_py2.py is a file name, not something code references. The removed module was sentry_sdk.tracing_utils_py2, so anything downstream that searches a repo for tracing_utils_py2.py will never match an import. It was also a Python‑2‑only internal module, and 2.0.0 drops Python 2 entirely, so no code that installs 2.0.0 can be using it.

I'd drop it. The simplest way is to have the shared classifier (classify.go) reject code spans that end in a file extension (.py, .ts, .go, …), log them as dropped, and then regenerate this golden with 7 events. If you'd rather keep it, the symbol should at least be tracing_utils_py2 (the module), and the PR should explain why the event is useful.

"type": "package_release",
"ecosystem": "npm",
"package": "@sentry/node",
"change": "removed_symbol",

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Please check which package these removals belong to. Both bullets are feat(core)!, so they're removals from @sentry/core. These events, though, name @sentry/node, and the registration also claims npm:@sentry/browser, which no event ever carries.

If BaseClient and hasTracingEnabled were not exported from @sentry/node 9.x, these events tell @sentry/node users something that doesn't apply to them, and miss the users who import them from @sentry/core. Could you confirm against @sentry/[email protected]'s exports (its index.d.ts) and say what you found in the PR? If they weren't re-exported, the attribution needs fixing. One option is to cover npm:@sentry/core as well and set the package from the bullet's scope; the other is to drop (core)! bullets for this source.

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.

1 participant