-
Notifications
You must be signed in to change notification settings - Fork 2.6k
fix(nx-dev): update docs code blocks usage #32998
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Conversation
The latest updates on your projects. Learn more about Vercel for GitHub.
|
✅ Deploy Preview for nx-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
View your CI Pipeline Execution ↗ for commit 89d2967
☁️ Nx Cloud last updated this comment at |
909ba84
to
5de1806
Compare
5de1806
to
fe00ea6
Compare
fe00ea6
to
7aa112f
Compare
605813c
to
7e299af
Compare
by default code blocks will get text as the lang but be explict so I don't have to look at the warnings in the terminal output
by default code blocks will get text as the lang but be explict so I don't have to look at the warnings in the terminal output
the team has spoken! fixes DOC-259
7e299af
to
2c0a80f
Compare
"@nuxt/schema": "^3.10.0", | ||
"@nx/angular": "22.0.0-beta.4", | ||
"@nx/conformance": "3.0.0", | ||
"@nx/conformance": "4.0.0", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
bump to conformance v4 so I can use the tree
and fileMapCache
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
rebasing w/ main added extra esbuild related deps after installing. not sure if expected or not. but might be fine
2c0a80f
to
89d2967
Compare
There was a problem hiding this 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 test failure for e2e-jest:e2e-ci--src/jest-root.test.ts is classified as 'environment_state' because:
-
Network/Registry Failure: The error
ERR_PNPM_FETCH_404 GET http://localhost:4873/combined-stream: Not Found - 404
indicates that the local npm registry used for e2e testing is missing thecombined-stream
package. -
No Correlation with PR Changes: The PR exclusively modifies documentation markdown files (239 files) to update code block syntax and add conformance rules. There are no changes to:
- Package dependencies (package.json)
- Lock files (pnpm-lock.yaml)
- Source code that would affect dependency resolution
- Any code that references or requires the
combined-stream
package
-
Environmental Indicators Present:
- Local registry failure (http://localhost:4873)
- Authorization header issues ("Bearer secr[hidden]")
- Package not found in registry during test setup
- Failure occurs during
pnpm dlx create-nx-workspace
command execution
-
Inconsistent Test Results: Two tests passed (React-related) while two failed (Angular-related), suggesting the issue is not deterministic and likely related to the state of the local registry or timing issues rather than code changes.
-
Failure During Test Setup: The error occurs while setting up the test environment, not during execution of any code affected by the PR's documentation changes.
The local npm registry used for e2e testing appears to be incomplete or misconfigured, missing the combined-stream
dependency required by axios@1.12.2
and form-data@4.0.4
when creating a new workspace. This is purely an environmental issue unrelated to the documentation updates in this PR.
No code changes are warranted or necessary. The local registry needs to be properly populated or refreshed before the e2e tests can pass.
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
by default code blocks will get text as the lang if not set or the lang is not supported
but we should be so I don't have to look at the warnings in the terminal output 😅
also remove the frame=none since the team preferred to have the terminal frame
Example of invalid codeblock messages

Also added conformance rule for validating image pages for public and src/assets/ directory
examples of incorrect absolute path ref from "public" folder and incorrect absolute path:
fixes DOC-242
fixes DOC-259