Repository navigation
changelog: SDK changelogs and release notes for Stripe, Sentry, Cloudflare, Octokit, ioredis, posthog-go #232
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
adssib
wants to merge
17
commits into
main
Choose a base branch
from
pl4-changelog-all
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+9,499
−54
Open
Changes from all commits
Commits
Show all changes
17 commits
Select commit
Hold shift + click to select a range
7f09c1c
changelog: read SDK changelogs, release notes and tag-listed releases
adssib bc122d6
add the stripe sdk changelog sources
adssib bd302f5
add the sentry sdk changelog sources
adssib abc91ca
add the cloudflare sdk and terraform changelog sources
adssib 1b60a10
add the octokit, ioredis and posthog-go changelog sources
adssib 894fdd2
changelog: follow renames to their end; names alone only under removed
adssib 1e985f4
Merge branch 'pl4-changelog-reader' into pl4-changelog-stripe
adssib 387bedd
Merge branch 'pl4-changelog-stripe' into pl4-changelog-sentry
adssib 04e889b
Merge branch 'pl4-changelog-sentry' into pl4-changelog-cloudflare
adssib ebd7fbf
cloudflare/typescript: pin 7.1.0, whose rename is plain
adssib f8c9064
Merge branch 'pl4-changelog-cloudflare' into pl4-changelog-more
adssib 417a120
octokit: renames followed to their end; octokit-net pins 0.5.2
adssib 0801380
changelog: a deprecation's replacement isn't followed as a rename
adssib f1b7cd1
Merge branch 'pl4-changelog-reader' into pl4-changelog-stripe
adssib 5d69c5a
Merge branch 'pl4-changelog-stripe' into pl4-changelog-sentry
adssib 90c5d49
Merge branch 'pl4-changelog-sentry' into pl4-changelog-cloudflare
adssib c452153
Merge branch 'pl4-changelog-cloudflare' into pl4-changelog-more
adssib File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Chained renames produce replacements that no longer exist. The octokit/rest v18.0.0 notes list both halves of several chains, and each bullet becomes its own event, so the golden tells users to migrate to names that v18 removed:
octokit.issues.replaceLabels→ replacementoctokit.issues.replaceAllLabels, butreplaceAllLabelsis itself "renamed tooctokit.issues.setLabels()"octokit.actions.listWorkflowJobLogs→downloadWorkflowJobLogs, which is itself renamed todownloadJobLogsForWorkflowRunoctokit.reactions.delete→deleteLegacy, which this same release removes ("deprecatedoctokit.reactions.deleteLegacy()has been removed")A codemod that follows these replacements turns working v17 code into code that breaks on v18. Since you already loop over the release's findings here, one fix is to collect the release's renamed and removed symbols first, then rewrite each
Replacementby following the chain to its end (replaceLabels→setLabels). If the chain ends in a removal, drop the replacement (or the event). Please regenerategithub-octokit-rest.jsonafterwards, and add a unit test that covers a two-step chain and a chain that ends in a removal.