Skip to content

add the octokit, ioredis and posthog-go changelog sources - #231

Open
adssib wants to merge 4 commits into
pl4-changelog-cloudflarefrom
pl4-changelog-more
Open

adssib wants to merge 4 commits into
pl4-changelog-cloudflarefrom
pl4-changelog-more

Conversation

@adssib

@adssib adssib commented Nov 21, 2026 •

Copy link
Copy Markdown
Contributor

Stacked on #227.

What this changes

Three more SDKs, under existing providers:

  • github/octokit-rest (npm:@octokit/rest) and github/octokit-net (nuget:Octokit): read from each GitHub release's notes (Notes: true; neither keeps a changelog file). Versions are the repos' published releases.
  • redis/ioredis (npm:ioredis): CHANGELOG.md at each tag; its majors are headed # [X.0.0].
  • posthog/go (go:github.com/posthog/posthog-go; events name …/v2 from 2.0.0): changesets "Major Changes".

Kind changelog; versions from npm, the repo's tags or its releases (no pins).

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: octokit-rest 17.11.2→18.0.0 (155 events: removals and renames), octokit-net 0.18.0→0.19.0 (1), ioredis 4.31.0→5.0.0 (1), posthog-go 1.44.1→2.0.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/github-octokit.md, providers/redis-ioredis.md, providers/posthog-go.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 release notes are GitHub's API JSON trimmed to html_url, tag_name, name, published_at, body. 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 #188, #202, #204 (not closing: the stories' other sources are other kinds or were skipped).

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 48s —— View job


⚠️ Merge after fixes. Metadata, provider pages, testdata and checks all pass, but two goldens contain events that would open wrong pull requests: a method marked obsolete is reported as removed, and some renames point to methods removed in the same release.

Rules

Rule Status Evidence
Metadata in the registration ✅ github, redis and posthog provider metadata matches their registrations in openapi/notices, catalog and migrationguide. Each source uses sdk() (id, layer, watches, URL, page) with the right packages (npm:@octokit/rest, nuget:Octokit, npm:ioredis, go:github.com/posthog/posthog-go). The repo has no hand-kept list.
Provider page ✅ providers/github-octokit.md, redis-ioredis.md and posthog-go.md each have a full Why this source section: link, date checked (2026-11-20), why this source, alternatives and a quote.
Golden test + quote ⚠️ All four goldens are over real saved copies, and each has a row in testdata/README.md (URL, tag commit, date, license, trimming). Every event has a source_url and a source_excerpt. But the octokit-net and octokit-rest goldens contain wrong events (see Bugs).
Drop test ✅ octokit-rest 17.11.2, octokit-net 0.18.0, ioredis 5.0.0-beta.4, posthog-go 1.44.1. The posthog and ioredis drop sections are patch or beta notes with no breaking section, so they're weak tests. Fine, but see the suggestion below.
Fetch only via env ✅ No new fetch code: File uses the existing env.Get paths (GitHubReleases, NPMReleases, GitHubTags).
Nothing private ✅ Leak guard is clean, and I found nothing private in the code, docs, commit or PR body.

Bugs

  1. octokit-net 0.19.0: an obsolete method is reported as removed (testdata/golden/github-octokit-net.json:20). The notes say the ISshKeysClient methods "are marked as obsolete and will be removed in a future release". GetAllForCurrent() still works in 0.19.0, yet the event says "code using it fails". The cause: the bare bullet `ISshKeysClient.GetAllForCurrent()` sits under "Breaking Changes", and the context that says it was only deprecated is a paragraph, not a bullet. The golden needs a release with a real removal, or this bullet shape needs to be dropped. 0.19.0 would make a good drop test. Inline comment has details.

  2. octokit-rest 18.0.0: some renames point to methods that are gone (testdata/golden/github-octokit-rest.json:2014, :1239, :414):

    • reactions.delete → deleteLegacy, but deleteLegacy is removed in the same release.
    • issues.replaceLabels → replaceAllLabels, but that one is renamed to setLabels.
    • actions.listWorkflowJobLogs → downloadWorkflowJobLogs, but that one is renamed to downloadJobLogsForWorkflowRun.

    A user who follows these hints still has broken code. Following the chain in File.Read (like the existing added check) would fix all three: resolve to the final name, or drop the replacement when the chain ends in a removal. The other 152 events I spot-checked match their bullets.

The ioredis (Redis#serverInfo) and posthog-go (Capture.Library, Exception.Library) events are correct.

Verified

  • go build ./...: passed
  • go vet ./...: passed
  • gofmt -l .: printed nothing
  • go test -race ./...: all packages passed, including plugins/changelog
  • python3 scripts/leak_guard.py --all: "no banned terms (8 hashed terms checked)"

I didn't check upstream sources live (e.g. that ioredis 4.31.0 comes right before 5.0.0 on npm). I relied on the saved copies and the PR's statement.

Non-blocking

  • providers/github-octokit.md says octokit.net's "Breaking changes" lists are dropped when they're signature changes. It's worth adding that a list headed "marked as obsolete" is a deprecation, not a removal, once bug 1 is fixed.
  • posthog-go 2.0.0 removes more than the golden catches: Config.CaptureMode, the CaptureMode type, CaptureModeLegacy and CaptureModeAnalyticsV1 are in a nested "### Breaking changes" inside a bullet. Missing them is fine under precision over recall; the page's Known gaps could mention it.
  • For a stronger drop test, the ioredis 5.0.0 section has its own non-event lines (allowUsernameInURI removed, Node.js version bump), and the test already checks these are dropped through Dropped.

]
},
"description": "`ISshKeysClient.GetAllForCurrent` was removed in Octokit 0.19.0: code using it fails.",
"migration_hint": "`ISshKeysClient.GetAllForCurrent()` (Octokit's release notes for 0.19.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 event is wrong. The 0.19.0 notes say these ISshKeysClient methods "are marked as obsolete and will be removed in a future release". GetAllForCurrent() still exists in 0.19.0 and code calling it still builds (it only gets a CS0618 warning). This event would open a PR saying "code using it fails", and that isn't true.

Why it happens: the explanation is a plain paragraph, not a bullet, so the classifier only sees the bare bullet `ISshKeysClient.GetAllForCurrent()` under a "Breaking Changes" heading and reads it as a removal. The other five bullets in the list are dropped only because they have arguments, so this release just happens to lose five of six.

Possible fixes:

  • Treat a bullet that is only a code span (nothing says what happened to it) as dropped, or
  • pin a different octokit.net release where something is actually removed (or a deprecation event, if the classifier can see the "obsolete" sentence).

Either way, 0.19.0 as it stands is a good case for the drop test.

"symbols": [
"octokit.reactions.delete"
],
"replacement": "octokit.reactions.deleteLegacy"

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

The replacement here was removed in the same release. This event tells users to rename reactions.delete → reactions.deleteLegacy, but these same 18.0.0 notes also say "deprecated octokit.reactions.deleteLegacy() has been removed" (that's event 1 in this file). Following the hint gives code that still breaks.

The same thing happens with chained renames in these notes:

  • line 1239: issues.replaceLabels → issues.replaceAllLabels, but replaceAllLabels → setLabels in the same release
  • line 414: actions.listWorkflowJobLogs → actions.downloadWorkflowJobLogs, but downloadWorkflowJobLogs → downloadJobLogsForWorkflowRun in the same release

File.Read already checks the release as a whole with added ("the same release adds X back"). A matching check would fix this: when a rename's replacement is itself removed or renamed in the same release, follow the chain to the final name (replaceLabels → setLabels), or emit removed_symbol without a replacement when the chain ends in a removal (delete).

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