Skip to content

add the stripe sdk changelog sources - #228

Open
adssib wants to merge 3 commits into
pl4-changelog-readerfrom
pl4-changelog-stripe
Open

adssib wants to merge 3 commits into
pl4-changelog-readerfrom
pl4-changelog-stripe

Conversation

@adssib

@adssib adssib commented Nov 21, 2026 •

Copy link
Copy Markdown
Contributor

Stacked on #227.

What this changes

Registers Stripe's seven SDK changelogs under the existing stripe provider: stripe/python (pypi:stripe), stripe/node (npm:stripe), stripe/go (go:github.com/stripe/stripe-go/v87), stripe/java (maven:com.stripe:stripe-java), stripe/ruby (rubygems:stripe), stripe/dotnet (nuget:Stripe.net), stripe/php (packagist:stripe/stripe-php). Every ⚠️ bullet that plainly removes or renames a class, method, property, constant or resource is one breaking event.

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 3.5.0→4.0.0 (4 events), node 9.16.0→10.0.0 (8), go 72.122.0→73.0.0 (38), java 20.136.0→21.0.0 (8), ruby 6.5.0→7.0.0 (5), dotnet 39.126.0→40.0.0 (5), php 8.12.1→9.0.0 (13)
  • 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/stripe-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 #186 (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 2m 3s —— View job


⚠️ Merge after fixes: the seven sources are well built and every check passes, but please confirm the Stripe PHP previous version (8.12.1 or 8.12.0) before the golden is merged.

Rules

Rule Status Evidence
Plugin list (Rule 1) ✅ plugins/changelog/stripe.go registers 7 sources with RegisterProvider. Provider id, name, category and homepage match the openapi registration of stripe (plugins/openapi/openapi.go:25). Each source has an id, layer (SDK), watches, URL, packages and page, built by sdk() in sdks.go. No hand-kept list was added.
Provider page ✅ (one wording fix) providers/stripe-sdks.md follows the template. Why this source has the link, the date checked (2026-11-20), the reasons, the alternatives and a quote. One sentence about what's read is inaccurate (see the inline comment).
Golden test and quote ⚠️ There are 7 goldens over real saved copies trimmed at the tag. Each README row has the URL, tag commit, date, license and a quote. Every event carries source_url and source_excerpt. The previous version for PHP needs confirming (see below).
Drop test ✅ One pinned drop release per source, taken from the same saved file (checkSDKs in sdks_test.go).
Fetch only via env ✅ No new fetch code; it reuses the changelog reader from #227.
Nothing private ✅ Nothing found in code, testdata, docs, the commit or the PR body. leak_guard.py --all is clean.

Bugs

  1. PHP previous_version may be a typo. In plugins/changelog/stripe_test.go:13, prev is 8.12.1 but drop is 8.12.0. Every other case uses the same version for both. The saved file and the README row both describe the trim as 9.0.0 + 8.12.0, and all 13 events in golden/stripe-php.json say "previous_version": "8.12.1". If stripe/stripe-php has no v8.12.1 tag, the golden records the wrong previous version. Please either fix it to 8.12.0 and regenerate the golden, or confirm in the PR that 8.12.1 exists. I couldn't check upstream tags from this run. (Inline comment.)

No other blocking problems found. I read every golden's events against its saved changelog. Each event is a plain removal named in the bullet's first sentence, and the prose-heavy bullets ("Remove ability to list…", "Remove deprecated error code constants from ErrorObject: …", "Change type of…") are correctly dropped.

Verified

  • go build ./...: OK
  • go vet ./...: OK
  • gofmt -l .: printed nothing
  • go test -race ./...: all packages pass, including plugins/changelog
  • python3 scripts/leak_guard.py --all: "no banned terms (8 hashed terms checked)"
  • make check itself was blocked by this run's permissions, so I ran its main steps above one at a time. make imports, make nethttp and make todos were not run separately.

Non-blocking

  • Renames under ⚠️ Renamed / ⚠️ Changed headings are never read. SectionKind (classify.go:23) doesn't treat these headings as breaking, and their bullets have no ⚠️ of their own. Plain renames like stripe-node-10.0.0-CHANGELOG.md:41 ("Rename InvoiceLineItemListUpcomingParams to InvoiceListUpcomingLinesParams.") therefore produce no event, and aren't logged as dropped either. This loses recall, not precision. Even so, the page says those bullets are read, so please add them to Known gaps, or fix it in changelog: read SDK changelogs, release notes and tag-listed releases #227 by treating a heading that starts with ⚠ as breaking. (Inline comment.)
  • Webhook event names come out as "symbols". golden/stripe-node.json event 2 lists order.payment_failed, transfer.failed and transfer.paid as removed_symbol. These are webhook event type strings (literal values in the TS types), not names code imports, but they pass the dotted-identifier check in names(). The impact on TypeScript users is real, so this is defensible, but a downstream code search for these "symbols" will hit string literals. Consider whether changelog: read SDK changelogs, release notes and tag-listed releases #227's reader should tell them apart.
  • The Go package registration will go stale. go:github.com/stripe/stripe-go/v87 is right today and the page explains that events name each release's own major. It will need a bump when v88 ships.

{StripeJava, "21.0.0", "20.136.0", "stripe-java-21.0.0-CHANGELOG.md", "", "20.136.0"},
{StripeRuby, "7.0.0", "6.5.0", "stripe-ruby-7.0.0-CHANGELOG.md", "", "6.5.0"},
{StripeDotnet, "40.0.0", "39.126.0", "stripe-dotnet-40.0.0-CHANGELOG.md", "", "39.126.0"},
{StripePHP, "9.0.0", "8.12.1", "stripe-php-9.0.0-CHANGELOG.md", "", "8.12.0"},

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

This is the only case where prev (8.12.1) and drop (8.12.0) differ. The saved file's two sections are 9.0.0 and 8.12.0, testdata/README.md describes the trim as "9.0.0 (the golden) and 8.12.0", and all 13 events in golden/stripe-php.json carry "previous_version": "8.12.1".

Can you confirm that a v8.12.1 tag exists in stripe/stripe-php and comes right before v9.0.0? I couldn't check that from CI. If it doesn't exist, the golden records the wrong previous version:

Suggested change
{StripePHP, "9.0.0", "8.12.1", "stripe-php-9.0.0-CHANGELOG.md", "", "8.12.0"},
{StripePHP, "9.0.0", "8.12.0", "stripe-php-9.0.0-CHANGELOG.md", "", "8.12.0"},

(then regenerate golden/stripe-php.json). If it does exist, please say so in the PR and note in the README row that 8.12.1's section was trimmed out.

Comment thread providers/stripe-sdks.md

## What the plugin reads and ignores

- Reads the release's section only. A bullet counts when it's marked `⚠️` or sits under a breaking or deprecation heading, and its first sentence is a plain template over code spans: `Remove X`, `Remove X from Y`, `Rename X to Y`, `X has been removed`, `Deprecated X in favor of Y`. The pull-request link it starts with is read past.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

This sentence overstates what the reader does for Stripe. Stripe's newer changelogs (node 10, php 9, and others) group bullets under ### ⚠️ Changed and ### ⚠️ Renamed headings, and the bullets inside carry no ⚠️ of their own. SectionKind (classify.go:23) only treats headings containing "removed", "breaking", "incompatible" or "deprecat" as breaking, so these sections come back as KindNone and are skipped without even being logged as dropped.

For example, stripe-node-10.0.0-CHANGELOG.md:41 reads "Rename InvoiceLineItemListUpcomingParams to InvoiceListUpcomingLinesParams.", which fits the Rename X to Y template exactly, yet golden/stripe-node.json has no renamed_symbol event.

That loses recall, not precision, so it isn't blocking here. But the page should be accurate. Either add it under Known gaps ("bullets under ⚠️ Changed / ⚠️ Renamed headings aren't read"), or have SectionKind treat a heading that starts with ⚠ as breaking (that change belongs in #227).

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