Skip to content
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

feat: update conventional config #97

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

FRSgit
Copy link

@FRSgit FRSgit commented Sep 13, 2024

Description

Took a swing at upgrading conventional-config and conventional-recommended-bump.
conventional-config was a pretty easy upgrade - almost nothing has changed there.
It was a bit more tricky with conventional-recommended-bump as they've changed API completely. In every case there is a (undocumented) migration path though. In this PR I took the direction of rewriting the "old API" to new one within the library so the migration for @release-it/conventional-changelog users would be as easy as possible.

But honestly? Looking at this now, I think there should be a breaking change introduced in @release-it/conventional-changelog to redo the options passed to the plugin. New API could look like this:

{
  commits: { /* options for bumper.commits */ },
  preset: { /* options for bumper.preset */ },
  tag: { /* options for bumper.tag */ },
  whatBump,
}

After doing this change it would be pretty easy to write a simple migration docs and say which old options go where in the new API - it's clearly visible in this PR.

By doing this @release-it/conventional-commits will remain as transparent as possible - it'll still just pass options to underlying APIs.

But, in the end it's your decision @webpro, so feel free to continue with this migration as you think is best.

Cheers ✌️

Resolves

#88

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