Skip to content

fix(release): breaking change contents extraction#33184

Merged
JamesHenry merged 1 commit intomasterfrom
changelog-breaking-change-extraction-fix
Oct 22, 2025
Merged

fix(release): breaking change contents extraction#33184
JamesHenry merged 1 commit intomasterfrom
changelog-breaking-change-extraction-fix

Conversation

@JamesHenry
Copy link
Copy Markdown
Collaborator

@JamesHenry JamesHenry commented Oct 22, 2025

Current Behavior

Git metadata is incorrectly extracted as part of the breaking change, as well as Co-authored-by data.

Expected Behavior

Git metadata and Co-authored-by are correctly stripped from breaking change notes.

Related Issue(s)

Fixes #

@JamesHenry JamesHenry requested a review from a team as a code owner October 22, 2025 13:55
@JamesHenry JamesHenry requested a review from AgentEnder October 22, 2025 13:55
@netlify
Copy link
Copy Markdown

netlify bot commented Oct 22, 2025

Deploy Preview for nx-docs ready!

Name Link
🔨 Latest commit 284b0f0
🔍 Latest deploy log https://app.netlify.com/projects/nx-docs/deploys/68f8e244ee6619000829293a
😎 Deploy Preview https://deploy-preview-33184--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
Copy link
Copy Markdown

vercel bot commented Oct 22, 2025

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 2:06pm

@nx-cloud
Copy link
Copy Markdown
Contributor

nx-cloud bot commented Oct 22, 2025

View your CI Pipeline Execution ↗ for commit 284b0f0

Command Status Duration Result
nx affected --targets=lint,test,test-kt,build,e... ✅ Succeeded 16m 40s View ↗
nx run-many -t check-imports check-commit check... ✅ Succeeded 2m 12s 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 15:11:32 UTC

@JamesHenry JamesHenry enabled auto-merge (squash) October 22, 2025 13:56
Copy link
Copy Markdown
Contributor

@nx-cloud nx-cloud bot left a comment

Choose a reason for hiding this comment

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

Nx Cloud has identified a possible root cause for your failed CI:

The failure is classified as 'environment_state' because it stems from a corrupted or improperly initialized cache file in the Nx workspace data directory, not from any code changes in the pull request.

The PR introduces changes to the changelog renderer that improve handling of complex commit messages by detecting and properly truncating breaking change descriptions before Co-authored-by sections or git metadata. Specifically, the code now checks for the pattern '---------\n\nCo-authored-by:' before falling back to the existing git metadata delimiter check.

The failing test "should update the workspace" in the plugin e2e-project generator is attempting to read project configuration, which triggers project graph creation. During this process, the Jest plugin tries to read a targets cache file that is either empty or contains invalid JSON. This results in the error: "ValueExpected in /home/workflows/workspace/.nx/workspace-data/jest-7930610538513362720.hash at 1:1".

This failure is not caused by the changelog renderer changes because:

  • The modified files (changelog-renderer/index.ts and index.spec.ts) are not imported or used by the plugin generator tests
  • The error occurs in the Jest plugin's internal caching mechanism during project graph initialization
  • The stack trace shows the error originates from readTargetsCache in the Jest plugin, not from any changelog-related code
  • Seven other test suites passed successfully, indicating the overall codebase is stable

The cache file corruption likely occurred due to parallel test execution, interrupted test runs, or other environmental factors that can cause transient file system issues during CI execution. This is a classic flaky test scenario where the test infrastructure state, rather than the application code, is the source of the failure.

A code change would likely not resolve this issue, so no action was taken.

Nx CloudView in Nx Cloud ↗


🎓 To learn more about Self Healing CI, please visit nx.dev

@JamesHenry JamesHenry merged commit 420091d into master Oct 22, 2025
21 of 22 checks passed
@JamesHenry JamesHenry deleted the changelog-breaking-change-extraction-fix branch October 22, 2025 15:11
@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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants