Skip to content

add the cloudflare sdk and terraform changelog sources - #230

Open
adssib wants to merge 4 commits into
pl4-changelog-sentryfrom
pl4-changelog-cloudflare
Open

adssib wants to merge 4 commits into
pl4-changelog-sentryfrom
pl4-changelog-cloudflare

Conversation

@adssib

@adssib adssib commented Nov 21, 2026 •

Copy link
Copy Markdown
Contributor

Stacked on #227.

What this changes

Registers under the existing cloudflare provider: cloudflare/typescript (npm:cloudflare), cloudflare/python (pypi:cloudflare), cloudflare/go (go:github.com/cloudflare/cloudflare-go/v7) and cloudflare/terraform (layer infra; no package: terraform isn't a package ecosystem in the registry, events carry ecosystem terraform, package cloudflare/cloudflare).

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: typescript 7.1.0→7.2.0 (11 events), python 5.5.0→5.6.0 (7), go 7.14.0→7.15.0 (1), terraform 5.28.1→5.29.0 (1)
  • 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/cloudflare-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 #203 (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

@claude

claude Bot commented Nov 21, 2026 •

Copy link
Copy Markdown

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


⚠️ Merge after fixes: the Python, Go and Terraform sources look right, but all 11 cloudflare/typescript golden events are false removals.

Thanks for the careful work here, @adssib: the Python, Go and Terraform sources, the testdata rows and the provider page are all in good shape. One source needs another look.

Rules

Rule Status Evidence
Metadata in the registration (Rule 1) ✅ plugins/changelog/cloudflare.go:7-15: provider id, name, category and homepage match plugins/notices/notices.go:74. sdk() fills in each source's id, layer (infra for terraform via layerOf), watches, URL, packages and page. No hand-kept list was added.
Provider page ✅ providers/cloudflare-sdks.md has every template section. Why this source has the links, the date checked (2026-11-20), why it's the best source, the alternatives and a quote.
Golden test and quote ⚠️ python, go and terraform: the goldens match their saved sections, and every event has source_url (raw file at the tag) and an excerpt. typescript: every event is wrong (see Bugs). testdata/README.md has a row for each file with URL, commit, date, license and quote.
Drop test ✅ One per source (6.5.0, 5.4.0, 7.13.1, 5.28.1), each a real section in the saved file, and each passes.
Fetch only via env ✅ Registration only, with no new fetch code. The reader uses env.Get.
Nothing private (Rule 2) ✅ Nothing in the code, testdata, commit message or PR body. The leak guard is clean.

Bugs

  1. cloudflare/typescript 7.2.0 emits 11 removals that aren't removals (inline). All 11 events come from #### Empty \body` params removed (cloudflare-typescript-7.2.0-CHANGELOG.md:72-87). Those methods still exist and only lost a placeholder body param, but each event says "dns.records.scanwas removed … code using it fails". The excerpts show the bullets were read as part ofBreaking Changes, and a bullet made only of code spans counts as a removed name. Events 6 and 11 also carry bare symbols (enable, forceNotify, deactivate), which would match unrelated calls. Meanwhile the real removals in that release (#### Removed Methods, and #### Removed Types` at lines 155–178) produce no event at all. Two ways to fix it:
    • have the reader treat #### sub-headings as sections, and count bare-name bullets only under headings that remove names (not params, fields or return types), then regenerate the golden and explain the new output in the PR; or
    • leave cloudflare/typescript out of this PR (registration, test case, testdata, golden and page row) and add it in a follow-up.

Verified

  • go vet ./...: passes, so the code builds.
  • gofmt -l .: prints nothing.
  • go test -race ./...: every package passes, including plugins/changelog. This shows the goldens match the current output, not that the output is right.
  • python3 scripts/leak_guard.py --all: "no banned terms (8 hashed terms checked)".
  • I couldn't run make check or go run ./cmd/list-plugins (make plugins): this runner needs approval for them. I checked the registration by reading the code and through the kittest.Registered test instead.
  • I read each golden file against its saved changelog section.

Non-blocking

  • Terraform foundation_dns: the symbol doesn't name the resource (cloudflare_zone_dns_settings). The page lists this under Known gaps, which is fine for now. Note that the same bullet says that on cloudflare_account_dns_settings the field "is dropped silently on upgrade", so that resource doesn't break.
  • Go event description: it names github.com/cloudflare/cloudflare-go 7.15.0 while subject.package is …/v7. This comes from the shared describe() (it uses f.Package, not f.installed()), not from this PR.
  • Terraform test case: prev and drop are both 5.28.1. That's correct, just worth knowing it's the same release used twice.

Comment on lines +72 to +74
#### Empty `body` params removed

The following methods no longer accept a placeholder `body` param. Remove `body: {}` from call sites.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Blocking (precision). All 11 events in golden/cloudflare-typescript.json come from this list, and none of these methods was removed. The changelog says they "no longer accept a placeholder body param", so client.dns.records.scan({ zone_id }) still works. Every event says "X was removed … code using it fails", which is wrong, and each one would become a wrong PR in someone's repo.

Why it happens: the reader puts these bullets in the ### Breaking Changes section (each excerpt says Breaking Changes, not this #### heading). It then reads a bullet made only of code spans as a bare removed name. Two of the bullets also produce bare symbols: enable, forceNotify and deactivate (events 6 and 11).

The real removals in this release are not caught at all: #### Removed Methods (line 11, dropped because of "along with") and #### Removed Types (lines 155–178, e.g. State, CacheVariant, Aegis). So for this file the source currently has precision 0.

Ways to fix it (your choice):

  • make #### sub-headings their own sections, and have a bare-name bullet count only under a heading that removes names (not "params removed", "fields removed", "Return Type Changes"); or
  • leave cloudflare/typescript out of this PR until the reader handles Stainless's TS layout, and pin it in a follow-up.

Either way, the golden needs to be regenerated and the PR should explain why the new output is right.

adssib and others added 3 commits November 20, 2026 21:16
7.2.0's events came from bare names under a heading about removed body
params: the methods still exist. With names alone read only under a
Removed heading, 7.2.0 has no event; 7.1.0's rename is the golden.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
Signed-off-by: adssib <[email protected]>
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