fix(ci): repair docs workflow broken since Feb 25 (YAML block scalar parse error)#344
Merged
bensonwong merged 3 commits intomainfrom Mar 16, 2026
Merged
Conversation
Multi-line JS template literals in the `script: |` block contained content at column 0 (e.g. `<details>`, plain prose), which fell below the 12-space YAML block scalar indentation threshold and terminated the script block early. GitHub could not parse the workflow file, causing every docs workflow run to fail immediately since 2026-02-25. Fix: collapse `linkCheckSection` and `body` template literals to single-line strings with explicit `\n` escapes so all content stays within the YAML block scalar's indentation level. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
📚 Documentation PreviewThe documentation has been built successfully. To preview locally:
|
| Status | Count |
|---|---|
| 🔍 Total | 391 |
| ✅ Successful | 336 |
| ⏳ Timeouts | 0 |
| 🔀 Redirected | 0 |
| 👻 Excluded | 20 |
| ❓ Unknown | 0 |
| 🚫 Errors | 35 |
Errors per input
Errors in docs/_site/api-reference.html
- [404] https://fonts.gstatic.com/ | Failed: Network error: Not Found
- [404] https://fonts.googleapis.com/ | Failed: Network error: Not Found
Errors in docs/_site/types.html
- [404] https://fonts.googleapis.com/ | Failed: Network error: Not Found
- [404] https://fonts.gstatic.com/ | Cached: Error (cached)
Errors in docs/_site/getting-started.html
- [404] https://fonts.gstatic.com/ | Failed: Network error: Not Found
- [404] https://fonts.googleapis.com/ | Failed: Network error: Not Found
Errors in docs/_site/verification-statuses.html
- [404] https://fonts.gstatic.com/ | Cached: Error (cached)
- [404] https://fonts.googleapis.com/ | Cached: Error (cached)
Errors in docs/_site/frameworks/langchain.html
- [404] https://fonts.gstatic.com/ | Failed: Network error: Not Found
- [404] https://fonts.googleapis.com/ | Failed: Network error: Not Found
Errors in docs/_site/frameworks/vercel-ai-sdk.html
- [404] https://fonts.gstatic.com/ | Failed: Network error: Not Found
- [404] https://fonts.googleapis.com/ | Failed: Network error: Not Found
Errors in docs/_site/components.html
- [404] https://fonts.googleapis.com/ | Failed: Network error: Not Found
- [404] https://fonts.gstatic.com/ | Failed: Network error: Not Found
Errors in docs/_site/index.html
- [404] https://fonts.gstatic.com/ | Failed: Network error: Not Found
- [404] https://fonts.googleapis.com/ | Failed: Network error: Not Found
Errors in docs/_site/frameworks/index.html
- [404] https://fonts.gstatic.com/ | Failed: Network error: Not Found
- [404] https://fonts.googleapis.com/ | Failed: Network error: Not Found
Errors in docs/_site/frameworks/nextjs.html
- [404] https://fonts.gstatic.com/ | Failed: Network error: Not Found
- [404] https://fonts.googleapis.com/ | Failed: Network error: Not Found
Errors in docs/_site/CONTRIBUTING.html
- [404] https://fonts.gstatic.com/ | Failed: Network error: Not Found
- [404] https://fonts.googleapis.com/ | Failed: Network error: Not Found
Errors in docs/_site/error-handling.html
- [404] https://fonts.gstatic.com/ | Failed: Network error: Not Found
- [ERR] file:///home/runner/work/deepcitation/deepcitation/docs/_site/api-reference.md | Failed: Cannot find file
- [404] https://fonts.googleapis.com/ | Failed: Network error: Not Found
- [ERR] file:///home/runner/work/deepcitation/deepcitation/docs/_site/getting-started.md | Failed: Cannot find file
- [ERR] file:///home/runner/work/deepcitation/deepcitation/docs/_site/styling.md | Failed: Cannot find file
Errors in docs/_site/code-examples.html
- [404] https://fonts.gstatic.com/ | Failed: Network error: Not Found
- [404] https://fonts.googleapis.com/ | Failed: Network error: Not Found
Errors in docs/_site/styling.html
- [404] https://fonts.gstatic.com/ | Cached: Error (cached)
- [404] https://fonts.googleapis.com/ | Cached: Error (cached)
Errors in docs/_site/404.html
- [404] https://fonts.gstatic.com/ | Failed: Network error: Not Found
- [404] https://fonts.googleapis.com/ | Failed: Network error: Not Found
Errors in docs/_site/curl-guide.html
- [404] https://fonts.googleapis.com/ | Failed: Network error: Not Found
- [404] https://fonts.gstatic.com/ | Failed: Network error: Not Found
Full Github Actions output
Workflow run: 23135460134
Contributor
❌ Playwright Test ReportStatus: Tests failed 📊 Download Report & Snapshots (see Artifacts section) What's in the Visual SnapshotsThe gallery includes visual snapshots for:
Run ID: 23135460145 |
v3.0.1 (56afc609) internally called actions/upload-artifact@v4 (tag-only), violating the repo's "all actions must be pinned to full SHA" enforcement. v4.0.0 (7b1f4a76) pins its internal upload-artifact call to the full commit SHA, satisfying the policy. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs.yml) has been failing with "workflow file issue" on every run since 2026-02-25 — 200+ consecutive failures, zero deployments to GitHub Pages.script: |block in thepreview-commentjob uses YAML literal block scalar syntax. Its indentation level is set at 12 spaces by the first JS line. Two multi-line template literals (linkCheckSectionandbody) contained content at column 0 (e.g.<details>, plain prose,---), which fell below the 12-space threshold and caused YAML to terminate the block scalar early. GitHub's parser then tried to interpret raw HTML/Markdown as YAML nodes and rejected the file.\nescapes so every source line in the script stays within the 12-space YAML block indentation.bodywas missing\nbefore${linkCheckSection}, which would have dropped the blank line before---when no lychee report is present.Test plan
0sfailure)buildjob completes: Jekyll builds successfully, lychee link check runspreview-commentjob posts a "📚 Documentation Preview" comment on this PRdeployjob publishes to GitHub Pages