fix(release): breaking change contents extraction#33184
Conversation
✅ Deploy Preview for nx-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
View your CI Pipeline Execution ↗ for commit 284b0f0
☁️ Nx Cloud last updated this comment at |
There was a problem hiding this comment.
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.
🎓 To learn more about Self Healing CI, please visit nx.dev
|
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. |
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 #