Make interlink dependency auto bump logic configurable #358
Conversation
🦋 Changeset is good to goLatest commit: 8573e24 We got this. This PR includes changesets to release 15 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
Some quick thoughts: I'd add a changeset for the CLI so this becomes available, and tests failed, but otherwise happy with this. This does up the need for #117Re: two major versions. This makes sense for those packages, and I don't really mind doing it. |
packages/types/src/index.ts
Outdated
| @@ -61,6 +61,8 @@ export type Config = { | |||
| linked: Linked; | |||
| access: AccessType; | |||
| baseBranch: string; | |||
| /** Whether to auto bump inter-linked dependencies part of the same release on patch bumps and above (default) or minor bumps and above. */ | |||
| interLinkAutoBump: "patch" | "minor"; | |||
There was a problem hiding this comment.
updateInternalDependencies is more clear to me, but I'm not super convinced.
Codecov Report
@@ Coverage Diff @@
## master #358 +/- ##
==========================================
+ Coverage 79.85% 79.96% +0.11%
==========================================
Files 40 40
Lines 1072 1083 +11
Branches 246 247 +1
==========================================
+ Hits 856 866 +10
- Misses 206 207 +1
Partials 10 10
Continue to review full report at Codecov.
|
Relates to #117 and #189.
We'd like the ability to opt-out of the auto dependency bumping that occurs to min version ranges when two or more packages are released together, specifically in the case where the dependency has only been patch bumped.
This PR includes one way of achieving this via a
interLinkAutoBumpconfig option (I couldn't think of a good name, ideas welcome) which specifies the minimum bump type that the auto bumping of inter linked dependencies will apply to. By default it's set to 'patch' which should not change current behaviour of changesets.I was originally going to add 'major' as an option as well but then decided against it since there isn't a way to specify bumping dependents (#117) and this configuration option doesn't change that.
It's unfortunate that adding a new feature behind a configuration option has resulted in two major releases. In my opinion, the package structure, function signaturres and/or versioning may need a rethink to avoid this going forward.