Fix docs CI: run linkcheck before publish step#1172
Fix docs CI: run linkcheck before publish step#1172sbryngelson merged 1 commit intoMFlowCode:masterfrom
Conversation
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>
|
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 · |
|
Caution Review failedThe pull request is closed. 📝 WalkthroughWalkthroughA 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
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Suggested labels
Poem
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
|
CodeAnt AI finished reviewing your PR. |
There was a problem hiding this comment.
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
User description
Summary
docs.ymlso linkcheck runs whilebuild/install/docs/mfc/still has filesThe Publish step uses
mv(notcp) to move built docs into the deploy repo, leaving the build directory empty. Onscheduleandworkflow_dispatchevents (where Publish is active), Lychee then finds zero files and fails withfailIfEmpty.This was the root cause of https://github.com/MFlowCode/MFC/actions/runs/22202143038/job/64217490447
Test plan
workflow_dispatchrun 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
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:
This lets you have a chat with CodeAnt AI about your pull request, making it easier to understand and improve your code.
Example
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:
This helps CodeAnt AI learn and adapt to your team's coding style and standards.
Example
Retrigger review
Ask CodeAnt AI to review the PR again, by typing:
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