Skip to content

fix(release)!: better respect version plan file contents for changelog entries - #33166

Merged
JamesHenry merged 3 commits into
masterfrom
changelog-rendering-for-version-plans
Oct 22, 2025
Merged

fix(release)!: better respect version plan file contents for changelog entries#33166
JamesHenry merged 3 commits into
masterfrom
changelog-rendering-for-version-plans

Conversation

@JamesHenry

Copy link
Copy Markdown
Contributor

Current Behavior

The rendered changelog is not faithful enough to the original version plan markdown contents.

Expected Behavior

The version plan author maintains maximum control over final changelog contents.

Related Issue(s)

Fixes #

@JamesHenry
JamesHenry requested a review from a team as a code owner October 21, 2025 17:55
@netlify

netlify Bot commented Oct 21, 2025

Copy link
Copy Markdown

Deploy Preview for nx-docs ready!

Name Link
🔨 Latest commit 23ee90d
🔍 Latest deploy log https://app.netlify.com/projects/nx-docs/deploys/68f8979f9da39c0008d98f72
😎 Deploy Preview https://deploy-preview-33166--nx-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@vercel

vercel Bot commented Oct 21, 2025

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Updated (UTC)
nx-dev Ready Ready Preview Oct 22, 2025 8:46am
@nx-cloud

nx-cloud Bot commented Oct 21, 2025

Copy link
Copy Markdown
Contributor

View your CI Pipeline Execution ↗ for commit 23ee90d

Command Status Duration Result
nx affected --targets=lint,test,test-kt,build,e... ❌ Failed 44m 36s View ↗
nx run-many -t check-imports check-commit check... ✅ Succeeded 2m 50s View ↗
nx-cloud record -- nx-cloud conformance:check ✅ Succeeded 2s View ↗
nx-cloud record -- nx format:check ✅ Succeeded 2s View ↗
nx-cloud record -- nx sync:check ✅ Succeeded <1s View ↗

☁️ Nx Cloud last updated this comment at 2025-10-22 09:27:30 UTC

}

if (this.isVersionPlans) {
this.conventionalCommitsConfig = {

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I am honestly not sure why this was hardcoded to defaults, it means custom config isn't respected even when present. It definitely makes sense to get rid of this, the defaults will have been set in config.ts in the case the user is not customizing

changelogEntryVersion: releaseVersion.rawVersion,
project: null,
isVersionPlans: false,
isVersionPlans: !!nxReleaseConfig.versionPlans,

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Again I don't have a good explanation for why this was previously hardcoded to false... it should respect the config

nx-cloud[bot]

This comment was marked as outdated.

nx-cloud[bot]

This comment was marked as outdated.

nx-cloud[bot]

This comment was marked as outdated.

@JamesHenry JamesHenry changed the title fix(release): better respect version plan file contents for changelog entries Oct 22, 2025
@JamesHenry
JamesHenry disabled auto-merge October 22, 2025 08:38
@JamesHenry
JamesHenry enabled auto-merge (squash) October 22, 2025 08:40
@JamesHenry
JamesHenry merged commit 8819dcc into master Oct 22, 2025
19 of 20 checks passed
@JamesHenry
JamesHenry deleted the changelog-rendering-for-version-plans branch October 22, 2025 09:27
@github-actions

Copy link
Copy Markdown
Contributor

This pull request has already been merged/closed. If you experience issues related to these changes, please open a new issue referencing this pull request.

@github-actions github-actions Bot locked as resolved and limited conversation to collaborators Oct 28, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

3 participants