Skip to content

fix(ci): repair docs workflow broken since Feb 25 (YAML block scalar parse error) #344

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.

Sign up for GitHub

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

Merged
bensonwong merged 3 commits into from
Mar 16, 2026
Merged

fix(ci): repair docs workflow broken since Feb 25 (YAML block scalar parse error) #344

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2951d9b
fix(ci): collapse template literals to fix YAML block scalar parse error
Mar 16, 2026
261dd60
fix(ci): bump upload-pages-artifact to v4.0.0 to fix SHA-pinning policy
Mar 16, 2026
41b9bd6
chore: style update for branding
Mar 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 3 additions & 26 deletions .github/workflows/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ jobs:
if-no-files-found: ignore

- name: Upload artifact
uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa # v3.0.1
uses: actions/upload-pages-artifact@7b1f4a764d45c48632c6b24a0339c27f5614fb0b # v4.0.0
with:
path: docs/_site

Expand Down Expand Up @@ -120,33 +120,10 @@ jobs:
if (lycheeReport) {
const hasErrors = lycheeExitCode !== '0';
const statusEmoji = hasErrors ? '⚠️' : '✅';
linkCheckSection = `

## ${statusEmoji} Link Check Results

<details>
<summary>Click to expand link check report</summary>

${lycheeReport}

</details>
`;
linkCheckSection = `\n\n## ${statusEmoji} Link Check Results\n\n<details>\n<summary>Click to expand link check report</summary>\n\n${lycheeReport}\n\n</details>\n`;
}

const body = `## 📚 Documentation Preview

The documentation has been built successfully.

**To preview locally:**
1. Download the \`github-pages\` artifact from [this workflow run](${artifactUrl})
2. Extract and serve with any static file server:
\`\`\`bash
cd artifact && python -m http.server 8000
\`\`\`
3. Open http://localhost:8000/deepcitation/
${linkCheckSection}
---
*Workflow run: ${runId}*`;
const body = `## 📚 Documentation Preview\n\nThe documentation has been built successfully.\n\n**To preview locally:**\n1. Download the \`github-pages\` artifact from [this workflow run](${artifactUrl})\n2. Extract and serve with any static file server:\n \`\`\`bash\n cd artifact && python -m http.server 8000\n \`\`\`\n3. Open http://localhost:8000/deepcitation/\n${linkCheckSection}\n---\n*Workflow run: ${runId}*`;

// Find existing comment
const { data: comments } = await github.rest.issues.listComments({
Expand Down
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ Show proof for every AI citation.
<div align="center">

[![CI](https://github.com/DeepCitation/deepcitation/actions/workflows/ci.yml/badge.svg)](https://github.com/DeepCitation/deepcitation/actions/workflows/ci.yml)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Zero Dependencies](https://img.shields.io/badge/Zero%20Dependencies-trusted-green)](https://www.npmjs.com/package/deepcitation)
[![~17KB](https://img.shields.io/badge/gzip-~17KB-brightgreen)](https://bundlephobia.com/package/deepcitation)
[![License: MIT](https://img.shields.io/badge/License-MIT-005595?style=flat-square)](https://opensource.org/licenses/MIT)
[![Zero Dependencies](https://img.shields.io/badge/Zero%20Dependencies-trusted-10b981?style=flat-square)](https://www.npmjs.com/package/deepcitation)
[![~17KB](https://img.shields.io/badge/gzip-~17KB-10b981?style=flat-square)](https://bundlephobia.com/package/deepcitation)

</div>

Expand Down
Loading