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

Migrate to conventional-changelog v6 + conventional-recommended-bump v10 #100

Merged
merged 6 commits into from
Oct 8, 2024

Conversation

webpro
Copy link
Contributor

@webpro webpro commented Oct 6, 2024

So let's get this going, it was long overdue.

First of all, bigshout out to @FRSgit who made ball roll in #97. And since I totally agree the options in this plugin should as much be passed through verbatim, I followed up his PR with this one that does just that.

Would be great to get this started and hear your thoughts, API feedback, bugs, etc!

This is under development in the v9 branch and updated docs are at https://github.com/release-it/conventional-changelog/blob/v9/README.md

The latest version in this branch can be installed using the command as provided by the pkg-pr-new bot below (npm i -D).

cc @will-stone, @skycaptain, @juancarlosjr97, @ardakod, @timmywil, @Blackclaws, @ygrishajev, @Blackclaws

NOTE: I could use some help maintaining this plugin. The thing is, I don't really use it myself. So not to spam everyone too much again later on I'm bringing that in here as well. Free free to respond or DM me about this.

Copy link

pkg-pr-new bot commented Oct 6, 2024

Open in Stackblitz

yarn add https://pkg.pr.new/@release-it/[email protected]

commit: deeb133

@will-stone
Copy link

Hey, sorry I’ve had the notification in my inbox for ages from #88. I am hoping I can get some time to look into this but, having become a father this year, my free coding time is scarce 😅

README.md Outdated
This option will be passed as the second argument to
[`bumper.parserOptions`](https://github.com/conventional-changelog/conventional-changelog/blob/master/packages/conventional-recommended-bump/README.md#api)

### `whatBump`
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nitpick:
If you're going with bumper prefix for other options (to scope them to underlying bumper package in a way, right?) then I think this one should be called:

Suggested change
### `whatBump`
### `bumperWhatBump`

just to follow the convention 🤷

Copy link
Contributor Author

@webpro webpro Oct 7, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed, actually prefer unprefixed but then we'd have parserOpts twice 🙄 but they might actually be the same thing in conventional-changelog land, I'll double-check that.

@FRSgit
Copy link

FRSgit commented Oct 6, 2024

Looks good! I've just updated version of the plugin on my monorepo and release process passed successfully! 🎉

Wrote just a single nitpick comment on the naming of whatBump property. But either way - from my perspective it looks ready to be released. Great work!

@webpro webpro merged commit deeb133 into master Oct 8, 2024
21 checks passed
@webpro
Copy link
Contributor Author

webpro commented Oct 8, 2024

The options are streamlined a bit and documentation is better structured now (i.e. options are listed in order of programmatic flow): https://github.com/release-it/conventional-changelog. I've also looked up type definitions in the conventional-changelog repos and added links.

The latest release is @release-it/conventional-changelog@next (9.0.0-next.0) and the idea is to publish v9 in a few days, depending on feedback. Feel free to discuss etc! Still open to any sort of ideas, feedback, etc.

Merging the branch closed this which wasn't really the intention, you can still comment!

@webpro webpro deleted the v9 branch October 11, 2024 16:30
@webpro
Copy link
Contributor Author

webpro commented Oct 11, 2024

v9 is out!

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.

3 participants