fix: document and support custom writer render functions - #324
Open
yangxu52 wants to merge 3 commits into
Open
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.
Summary
@conventional-changelog/template@1.2.1as a direct runtime dependencywriterOpts.commitPartialimported from an ESM.versionrc.jsRoot cause
Version 13 upgraded conventional-changelog from v4 to v8, where Handlebars template strings and partial files were replaced by JavaScript render functions.
The v13 migration guide still stated that
writerOptsoverrides worked as before, which incorrectly implied that the removed Handlebars template interfaceremained compatible. The official template helpers were also only available transitively rather than being declared as a supported runtime dependency.
Implementation
@conventional-changelog/template@1.2.1as a direct dependency.versionrc.jswordshelperwriterOpts.commitPartialmainTemplatetotemplate(context)Validation
npm exec vitest run test/esm-config.integration-test.jsnpm testnpm run lintnpm run format:checkgit diff --checkNon-goals
commit-and-tag-version/templatesubpath exportFixes #323