fix(deps): pin conventional-changelog preset to the v9 line - #2884
Merged
Conversation
|
Tick the box to add this pull request to the merge queue (same as
|
The docs release path has failed at generateNotes on every main push
with a release to make since the preset was bumped to ^10.4.0.
Preset major 10 requires conventional-changelog-writer major 9 or
newer, but semantic-release@25.0.9 resolves
@semantic-release/release-notes-generator@14.1.0, which pins writer
^8.0.0 and therefore 8.2.0. The failure is not a version check but a
planted handlebars template: @conventional-changelog/template@1.4.0
supplies a mainTemplate whose body is the error sentence itself, a
writer-8 renderer compiles it and throws it as a Missing helper
error, and writer 9 ignores the option entirely.
Upgrading forward is unavailable. Every semantic-release channel,
including 26.0.0-beta.1, depends on release-notes-generator ^14.1.0,
and only 15.0.0-beta.2 accepts writer 9, which no semantic-release
release references. A top-level override forcing writer 9 also fails,
because the package manager nests writer 8 beneath
release-notes-generator to satisfy its own range and the nested copy
is the one that renders. Pinning to a lower v10 does not help either,
since presets 10.0.0 through 10.3.0 all resolve
@conventional-changelog/template to 1.4.0 today.
9.3.1 is the version upstream itself tests against writer 8, and
unlike 10.4.0 it does not raise the node engine requirement to 22.
Both manifests change together because the root declares
workspaces: ["packages/*"] and bun.lock keys packages by name, so one
version resolves for the whole workspace.
The renovate rule is required rather than hygiene:
.github/workflows/regenerate-lock-files.yaml re-runs the generator on
Renovate pull requests and amends the branch, so without the hold the
next Renovate run restores ^10.4.0 and re-materializes it into
bun.nix automatically. That workflow is gated to renovate[bot], so
bun.nix is regenerated here by hand.
Verification. The repository's own check set does not cover this
defect: the release path runs only as a post-build effect on main,
and the package-vanixiets-docs* checks never invoke generateNotes. A
green check set is therefore not evidence that this is fixed, so the
primary evidence is a paired reproduction. generateNotes from
release-notes-generator@14.1.0 was invoked with the repository's real
pluginConfig against the repository's own bun-resolved tree over the
real 9 commits since @vanixiets/docs-v0.6.0, holding writer at 8.2.0
and changing only the preset: 10.4.0 fails with the CI error
verbatim, and 9.3.1 renders the 0.6.1 notes correctly.
Checks run, selected as the narrowest set that would fail if this
change were wrong:
nix build --no-link --print-out-paths \
.#checks.aarch64-darwin.{treefmt,package-vanixiets-docs-deps,\
package-vanixiets-docs,package-vanixiets-docs-test-unit}
All four pass. package-vanixiets-docs-deps is the derivation that
materializes node_modules from bun.nix, so a stale or inconsistent
lockfile fails there, and its log shows
bun-pkg-conventional-changelog-conventionalcommits-9.3.1.drv;
package-vanixiets-docs builds atop it; treefmt covers the changed nix
and json; -test-unit confirms the retuned tree still supports the
test runner. Deliberately left out: -test-e2e and -test-linkcheck,
which exercise docs site content this diff does not touch, and the
full check set, whose blast radius far exceeds a dependency pin.
cameronraysmith
force-pushed
the
fm/vx-release-notes-preset-pin
branch
from
September 1, 2026 05:37
121638e to
ab6c91e
Compare
cameronraysmith
changed the base branch from
main
to
fm/vx-stibnite-darwin-builder
September 1, 2026 05:37
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.
Problem
The docs release path has failed at
generateNoteson every main push with a release to make since Renovate raisedconventional-changelog-conventionalcommitsto^10.4.0. No release has been published by thedefault.release-packageseffect since.Preset major 10 requires
conventional-changelog-writermajor 9 or newer, butsemantic-release@25.0.9resolves@semantic-release/release-notes-generator@14.1.0, which pins writer^8.0.0and therefore 8.2.0.The mechanism is not a version check but a planted handlebars template:
@conventional-changelog/template@1.4.0supplies amainTemplatewhose body is the error sentence itself. A writer-8 renderer compiles it and throws it as aMissing helpererror; writer 9 ignores the option entirely. This bump did not create the incompatibility, it made an existing silent one loud.Why pin rather than upgrade
Upgrading forward is unavailable today. Every
semantic-releasechannel, including26.0.0-beta.1, depends on release-notes-generator^14.1.0, and only15.0.0-beta.2accepts writer 9, which nosemantic-releaserelease references.Two other routes were eliminated by direct test rather than by reading ranges. A top-level override forcing writer 9 fails, because the package manager nests writer 8 beneath release-notes-generator to satisfy its own range and the nested copy is the one that renders. Pinning to a lower v10 also fails, since presets 10.0.0 through 10.3.0 all resolve
@conventional-changelog/templateto 1.4.0 today.9.3.1 is the version upstream itself tests against writer 8, and unlike 10.4.0 it does not raise the node engine requirement to 22.
Changes
Both manifests change together because the root declares
workspaces: ["packages/*"]andbun.lockkeys packages by name, so one version resolves for the whole workspace.package.json,packages/docs/package.json:^10.4.0to^9.3.1bun.lock,bun.nix: regenerated vianix run .#regenerate-bun-nix.github/renovate.json: hold the package below 10The Renovate rule is required rather than hygiene.
.github/workflows/regenerate-lock-files.yamlre-runs the generator on Renovate pull requests and amends the branch, so without the hold the next Renovate run restores^10.4.0and re-materializes it intobun.nixautomatically. That workflow is gated torenovate[bot], sobun.nixis regenerated here by hand.Verification
The repository's own check set does not cover this defect, and a green check set is not evidence that this is fixed. The release path runs only as a post-build effect on main, and the
package-vanixiets-docs*checks never invokegenerateNotes. Pull request builds are also structurally blind to it:modules/apps/docs/preview-version.shpasses--plugins, which discards the per-pluginpreset: "conventionalcommits"option, and wraps the invocation in$( ... || true).The primary evidence is therefore a paired reproduction.
generateNotesfrom@semantic-release/release-notes-generator@14.1.0was invoked with the repository's realpluginConfigagainst the repository's own bun-resolved tree over the real 9 commits since@vanixiets/docs-v0.6.0, holding writer at CI's exact 8.2.0 and changing only the preset:The rendered output under the fix is correct, not merely non-throwing:
Checks run
Selected as the narrowest set that would fail if this change were wrong:
All four pass.
package-vanixiets-docs-depsis the derivation that materializesnode_modulesfrombun.nix, so a stale or inconsistent lockfile fails there, and its log showsbun-pkg-conventional-changelog-conventionalcommits-9.3.1.drv.package-vanixiets-docsbuilds atop it,treefmtcovers the changed nix and json, and-test-unitconfirms the retuned tree still supports the test runner.Deliberately left out:
-test-e2eand-test-linkcheck, which exercise docs site content this diff does not touch, and the full check set, whose blast radius far exceeds a dependency pin.Not verified
The publish step after
generateNoteswas not executed, since that needs thex86_64-linuxclosure and CI credentials. Those preconditions were already passing in the failing logs, so clearing this check is expected but not directly demonstrated.Out of scope
The
|| trueand--pluginsoverride inpreview-version.shmean pull request builds cannot detect a broken production release path, which is how this reached main unnoticed. Making the preview exercise the real plugin configuration, or at least propagate its exit status, would have caught it on the Renovate pull request. Not changed here.