Skip to content

Fix docs CI: run linkcheck before publish step#1172

Merged
sbryngelson merged 1 commit intoMFlowCode:masterfrom
sbryngelson:docs-gallery-and-fixes
Feb 19, 2026
Merged

Fix docs CI: run linkcheck before publish step#1172
sbryngelson merged 1 commit intoMFlowCode:masterfrom
sbryngelson:docs-gallery-and-fixes

Conversation

@sbryngelson
Copy link
Member

@sbryngelson sbryngelson commented Feb 19, 2026

User description

Summary

  • Swap Lychee linkcheck and Publish steps in docs.yml so linkcheck runs while build/install/docs/mfc/ still has files

The Publish step uses mv (not cp) to move built docs into the deploy repo, leaving the build directory empty. On schedule and workflow_dispatch events (where Publish is active), Lychee then finds zero files and fails with failIfEmpty.

This was the root cause of https://github.com/MFlowCode/MFC/actions/runs/22202143038/job/64217490447

Test plan

  • Trigger a workflow_dispatch run of the Documentation workflow and verify it passes

🤖 Generated with Claude Code


CodeAnt-AI Description

Run linkcheck before publishing docs to prevent false failures

What Changed

  • The documentation link checker now runs before the Publish step so it sees the built site files
  • Scheduled and manual documentation workflow runs no longer fail when the Publish step moves files out of the build directory
  • Publish behavior and deployment to the docs repo remain unchanged

Impact

✅ Fewer documentation CI failures on scheduled/manual runs
✅ Clearer linkcheck results that reflect actual built docs
✅ More reliable scheduled docs publishes

💡 Usage Guide

Checking Your Pull Request

Every time you make a pull request, our system automatically looks through it. We check for security issues, mistakes in how you're setting up your infrastructure, and common code problems. We do this to make sure your changes are solid and won't cause any trouble later.

Talking to CodeAnt AI

Got a question or need a hand with something in your pull request? You can easily get in touch with CodeAnt AI right here. Just type the following in a comment on your pull request, and replace "Your question here" with whatever you want to ask:

@codeant-ai ask: Your question here

This lets you have a chat with CodeAnt AI about your pull request, making it easier to understand and improve your code.

Example

@codeant-ai ask: Can you suggest a safer alternative to storing this secret?

Preserve Org Learnings with CodeAnt

You can record team preferences so CodeAnt AI applies them in future reviews. Reply directly to the specific CodeAnt AI suggestion (in the same thread) and replace "Your feedback here" with your input:

@codeant-ai: Your feedback here

This helps CodeAnt AI learn and adapt to your team's coding style and standards.

Example

@codeant-ai: Do not flag unused imports.

Retrigger review

Ask CodeAnt AI to review the PR again, by typing:

@codeant-ai: review

Check Your Repository Health

To analyze the health of your code repository, visit our dashboard at https://app.codeant.ai. This tool helps you identify potential issues and areas for improvement in your codebase, ensuring your repository maintains high standards of code health.

Summary by CodeRabbit

  • Chores
    • Optimized the documentation build workflow by reordering validation steps to occur earlier in the process, ensuring documentation quality checks are performed before publishing.

The Publish step uses mv (not cp) to move files to the deploy
repo, leaving build/install/docs/mfc/ empty. Lychee then finds
no files and fails. This only triggers on schedule/workflow_dispatch
events where the Publish step is active.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings February 19, 2026 22:25
@codeant-ai
Copy link
Contributor

codeant-ai bot commented Feb 19, 2026

CodeAnt AI is reviewing your PR.


Thanks for using CodeAnt! 🎉

We're free for open-source projects. if you're enjoying it, help us grow by sharing.

Share on X ·
Reddit ·
LinkedIn

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 19, 2026

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

A GitHub Actions workflow file is updated to reorder the execution sequence of steps in the documentation pipeline, moving the Lychee link checking step earlier in the workflow to occur before the documentation publishing step.

Changes

Cohort / File(s) Summary
CI/CD Workflow Reordering
.github/workflows/docs.yml
Reordered workflow steps: Lychee linkcheck step moved to execute prior to Publish Documentation block instead of after.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested labels

Review effort 1/5, size:XS

Poem

🐰 Hop, hop, the links must check early,
Before the docs are shared, oh so fairly!
Reorder the steps with care so divine,
Let Lychee verify each hyperlink line!

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@codeant-ai codeant-ai bot added the size:XS This PR changes 0-9 lines, ignoring generated files label Feb 19, 2026
@codeant-ai
Copy link
Contributor

codeant-ai bot commented Feb 19, 2026

CodeAnt AI finished reviewing your PR.

@sbryngelson sbryngelson merged commit ad35e0e into MFlowCode:master Feb 19, 2026
25 of 26 checks passed
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR fixes a CI workflow failure in the Documentation workflow by reordering two steps. The Publish step uses mv to move built documentation files, leaving the build directory empty. When linkcheck ran afterward on scheduled/workflow_dispatch events, it failed due to finding zero files. Moving the linkcheck step before the Publish step ensures files are still present for validation.

Changes:

  • Moved the "Linkcheck - Lychee" step to run before the "Publish Documentation" step

Copy link
Contributor

@cubic-dev-ai cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 1 file

Confidence score: 5/5

  • Automated review surfaced no issues in the provided summaries.
  • No files require special attention.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size:XS This PR changes 0-9 lines, ignoring generated files

Development

Successfully merging this pull request may close these issues.

1 participant

Comments