fix(ci): extend MDX img check to fern/ and .mdx files#283
Conversation
Extend the grep to cover fern/ and *.mdx in addition to docs/*.md. Add comments explaining the inline and single-line choices. Matches the pattern settled on in NVIDIA/NVSentinel#1215 and NVIDIA/aicr#620. Signed-off-by: Pete MacKinnon <[email protected]>
54c9986 to
77bf17c
Compare
Greptile SummaryThis PR extends the Confidence Score: 5/5Safe to merge — a minimal, focused CI improvement with no production impact. The only finding is a P2 style suggestion about || true masking grep errors, which does not affect correctness in practice since fern/ is always present in the repo. All logic (regex, --include flags, directory arguments) is correct. No files require special attention. Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[fern-docs-ci workflow triggered] --> B[Checkout repository]
B --> C[Check markdown filename conventions\ndocs/ lowercase+hyphens]
C --> D[Setup Node.js]
D --> E[Install Fern CLI]
E --> F{Check MDX safety\ngrep non-self-closing img tags}
F -->|Found in docs/*.md fern/*.md fern/*.mdx docs/*.mdx| G[Fail: print error exit 1]
F -->|None found| H[Fern check]
H --> I[Check links lychee offline]
I --> J[CI passes]
|
|
/ok-to-test 77bf17c |
Description
Extends the
Check MDX safetygrep step added in #282 to also coverfern/and*.mdxfiles, not justdocs/*.md. Adds comments explaining the intentionally inline and single-line design choices.Matches the pattern settled on in NVIDIA/NVSentinel#1215 and NVIDIA/aicr#620.
Fixes #281
Checklist
git commit -s).