Migrate changelog management to hark - #2291
Draft
xavdid wants to merge 1 commit into
Draft
Conversation
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Why?
This is the private-preview version of our
harkmigration. See the linked PR below this description for more info.This PR differs from
masterbecause its.harkfiles only include information about theprivate-previewbranch. As a result, its changelog drops all information about GA releases. We might re-add these in the future, but we'll have to figure out a good way to do it. In the meantime, we add a line to the non-GA changelogs that mention that these changes are a superset of the GA ones.Past that, this branch went through the same backfill process as
master- break up theCHANGELOGand generate a bunch of files from it.Note
The old hand-written file on this branch carried the GA releases and, from before this branch and
betadiverged in late 2025, roughly a hundred-beta.Nsections as well. The generated one is alpha-only, so all of those entires are gone. They're not lost though- the GA entries are onmasterand the beta ones are onbeta, each in that branch's own changelog. Some prose on this branch still cross-references a beta version that this file no longer lists; that has been kept as-is.Note
CI will fail on this PR while https://github.com/stripe/hark is still private. We'll flip that to public very soon (see https://go/j/RUN_CODE-15185)
Afterwards, this PR will still have a failing CI job because it includes breaking changefiles but no migration guide. I'll just merge through that, since this is a one-time import.
What?
.harkdirectory, which holds all the information needed to generate a changelog:versions.jsonwhich lists every release, its release date, and the pinned API version (if present).change.mdfilesintro-<version>.mdfileshark buildto transitionCHANGELOG.mdinto a generated filealphaversions, this dropped a bunch of info. this is intended.## Changelog## Configurationsectionchangelog.ymlto enforce changelog related rules:stripe/hark/*.harkisn't shipped with the SDK itselfSee Also
masterversion of this PR.Configuration
skip-changefile: This PR does not need a changefile. (requires CI re-run)