fix(ci): pin semantic-release tooling and restore v0.95.0 notes#989
fix(ci): pin semantic-release tooling and restore v0.95.0 notes#989nielspardon wants to merge 2 commits into
Conversation
nielspardon
force-pushed
the
semantic-release-fix
branch
from
ee42798 to
b319460
Compare
|
This also ports the fix for stripping git trailers from substrait-io/substrait#1099 to substrait-java |
nielspardon
force-pushed
the
semantic-release-fix
branch
from
b319460 to
cbe6e12
Compare
nielspardon
force-pushed
the
semantic-release-fix
branch
from
cbe6e12 to
a44e1d2
Compare
nielspardon
requested review from
andrew-coleman,
benbellick,
bestbeforetoday and
vbarua
bestbeforetoday
left a comment
bestbeforetoday
left a comment
There was a problem hiding this comment.
Do we really need the RELEASE_DRY_RUN environment variable and programmatic manipulation of the semantic release configuration in addition to the standard --dry-run command-line argument? This already skips publishing, and it looks like the programmatic configuration manipulates (removes) publishing setting that (I guess) should not be used with --dry-run anyway. Without manually testing it is hard for me to tell for sure.
| -p "semantic-release@25.0.5" \ | ||
| -p "@semantic-release/commit-analyzer@13.0.1" \ | ||
| -p "@semantic-release/release-notes-generator@14.1.1" \ | ||
| -p "@semantic-release/changelog@7.0.0-beta.1" \ |
There was a problem hiding this comment.
Using a prerelease beta version does not seem ideal unless there is some reason that release versions are not compatible or do not include some essential functionality. The latest recommended release is currently 6.0.3.
There was a problem hiding this comment.
Good catch — there's no reason to be on the beta here. @semantic-release/changelog@6.0.3 is the current latest dist-tag and declares semantic-release >=18.0.0 as its peer dependency, so it's compatible with the pinned semantic-release@25.0.5. I've pinned 6.0.3 in both run.sh and dry_run.sh and validated it with a dry run: the preset resolves cleanly and the notes render correctly (0.95.0 → 0.95.1).
| import { createRequire } from "node:module"; | ||
| import { pathToFileURL } from "node:url"; | ||
|
|
||
| const loadPreset = async () => { | ||
| try { | ||
| return (await import("conventional-changelog-conventionalcommits")).default; | ||
| } catch { | ||
| const require = createRequire(pathToFileURL(process.argv[1])); | ||
| const resolved = pathToFileURL( | ||
| require.resolve("conventional-changelog-conventionalcommits") | ||
| ).href; | ||
| return (await import(resolved)).default; | ||
| } | ||
| }; | ||
| const conventionalcommits = await loadPreset(); |
There was a problem hiding this comment.
I am not sure why the import handling is so complicated here. The examples in the documentation are much simpler, using static rather than dynamic imports, and more what I would expect for ESM imports.
There was a problem hiding this comment.
The dynamic import + fallback is unfortunately load-bearing given how we invoke the tool. The release scripts run semantic-release via npx -p …, which installs conventional-changelog-conventionalcommits into a temporary node_modules alongside the semantic-release binary. A bare static import from this config resolves relative to the config file's own directory (the repo root, which has no node_modules) and fails with ERR_MODULE_NOT_FOUND — so the catch re-resolves the preset relative to the running semantic-release binary (process.argv[1]). The static-import example in the docs assumes the preset is installed as a local devDependency, which isn't the case here.
This was ported from the spec repo but the explanatory comment got dropped in the port — I've restored it so the "why" lives next to the code.
…nfig Address review feedback on the semantic-release config: - pin @semantic-release/changelog to the stable 6.0.3 (latest, peer semantic-release >=18.0.0) instead of 7.0.0-beta.1; there is no functional reason for the prerelease. Validated with a dry run. - restore the explanatory comments that were dropped when the config was ported from the spec repo: why the preset import needs the npx temp-node_modules fallback, and why the publishing plugins are omitted via RELEASE_DRY_RUN rather than guarded by --dry-run (semantic-release still runs verifyConditions in dry-run mode, so @semantic-release/github would fail without a token). Corrected the dry-run description, which wrongly claimed dry-run skips only tag and push.
Yes — this is a deliberate safety mechanism copied from the spec repo (substrait-io/substrait#1099), and My dry run confirms this end to end — it completes token-free precisely because those plugins are dropped: I've restored the comment explaining this (dropped in the port) and corrected it — the original claimed dry-run "only skips tag and push," which isn't accurate. |
2 participants
Summary
Fixes semantic-release changelog generation and restores the missing
v0.95.0changelog entry.Changes
ci/release/run.shandci/release/dry_run.sh.releaserc.jsonto.releaserc.mjswriterOpts.transformhook in.releaserc.mjsto strip git trailers likeSigned-off-by:from breaking-change notesci/release/run.shopt into real-release mode withRELEASE_DRY_RUN=falseci/release/dry_run.shuse the pinned toolchain and repo configv0.95.0entry inCHANGELOG.mdRoot cause
The empty
v0.95.0release notes were caused by floating release-tool dependencies. In particular,conventional-changelog-conventionalcommits@10.xregressed changelog generation in this setup, while9.3.1still generated the expected sections.Validation
conventional-changelog-conventionalcommits@9.3.1restores proper release notes generationv0.95.0release range