feat(conventional-changelog-presets): supported new preset format #526
Conversation
BREAKING CHANGE: the new preset format is a breaking change when compared to the previous preset format. updating to support the new format means that the old preset format is no longer supported. update your preset to the latest version to maintain compatibility
|
4 unit tests are failing when comparing the transform function in |
| loadedConfig = await (typeof loadedConfig === "function" | ||
| ? isPlainObject(presetConfig) | ||
| ? loadedConfig(presetConfig) | ||
| : promisify(loadedConfig)() | ||
| : loadedConfig); | ||
|
|
There was a problem hiding this comment.
since this took me a bit to understand, capturing the reason this is being removed. with the previous preset format, most presets returned an object, but the conventionalcommits preset returned a function that accepted config.
the change that resulted in the breaking changes across the conventional-changelog presets was an effort to unify the interface across those presets. therefore, we can instead pass the config above and remove the handling of the different potential return shapes. nice work @dangreen!
There was a problem hiding this comment.
i figured this out after cutting the first beta of the commit-analyzer plugin, so will make this change there too soon
| } else if (config) { | ||
| loadedConfig = importFrom.silent(__dirname, config) || importFrom(cwd, config); | ||
| loadedConfig = await (importFrom.silent(__dirname, config) || importFrom(cwd, config))(); |
There was a problem hiding this comment.
this should also accept the config, but we dont currently have a test for that case, so want to add those together
There was a problem hiding this comment.
in the interest of getting the beta promoted, i'm ok with completing this detail after this is merged
| } else { | ||
| loadedConfig = conventionalChangelogAngular; | ||
| loadedConfig = await conventionalChangelogAngular(); |
There was a problem hiding this comment.
the angular config currently does not accept config, so i think it is ok to avoid passing the config here
|
similar to the pr for the commit-analyzer, this updates the conventional-changelog presets and adjusts loading to handle the new format. conventional-changelog-writer has not yet been updated since it appears to not handle reverts the same way. if that is an expected change, i have not investigated far enough to understand what adjustment we need to make. |
…ional-changelog expectations based on conventional-changelog/conventional-changelog#1121 (comment). however, assuming the previous order actually aligned with how core provides the list, this will need to be coordinated with reversing that list somewhere
…nerator into beta
…eration with each load as confirmed in conventional-changelog/conventional-changelog#1121 (comment)
…opped v19 support BREAKING CHANGE: the minimum required node version is now v18.17, v19 support has been dropped, and the minimum required in the v20 range is v20.6.1
…nerator into beta
|
🎉 This PR is included in version 12.0.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
BREAKING CHANGE: the new preset format is a breaking change when compared to the previous preset format. updating to support the new format means that the old preset format is no longer supported. update your preset to the latest version to maintain compatibility