[docs-workflow] Make translation publishing atomic#511
Conversation
📝 WalkthroughWalkthroughThe documentation translation workflow now skips package scripts during dependency installation, runs consolidation only after successful translation, and treats cache-fragment download failures as fatal. ChangesTranslation workflow reliability
Estimated code review effort: 1 (Trivial) | ~5 minutes Possibly related PRs
Suggested reviewers: Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
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 |
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
.github/workflows/translate-docs.yml (1)
135-137: 🗄️ Data Integrity & Integration | 🟠 Major | ⚡ Quick winFail the translation job when any expected artifact is missing.
Removing
continue-on-erroronly makes the download step fail on a download error. The matrix upload steps still useif-no-files-found: warn, so a locale can finish successfully without producing a translation or cache artifact; the glob download and merge then proceed with the remaining locales, allowing a partial publication.Change both upload steps to
if-no-files-found: error(and/or explicitly validate every expected locale before merging).🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In @.github/workflows/translate-docs.yml around lines 135 - 137, Update both matrix artifact upload steps to use if-no-files-found: error instead of warn, ensuring each locale must produce its expected translation and cache artifacts before the download and merge steps run. Keep the existing artifact names and merge flow unchanged.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Outside diff comments:
In @.github/workflows/translate-docs.yml:
- Around line 135-137: Update both matrix artifact upload steps to use
if-no-files-found: error instead of warn, ensuring each locale must produce its
expected translation and cache artifacts before the download and merge steps
run. Keep the existing artifact names and merge flow unchanged.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: c6c15ebf-97f2-4177-9a07-c9d7d2ebe68a
📒 Files selected for processing (1)
.github/workflows/translate-docs.yml
|
Superseded by #512, which now includes this PR's atomic translation publishing changes together with the AgentEye language-navigation fix and pre-publish Mintlify/MDX validation. |
Summary
Verification
bun install --frozen-lockfile --ignore-scriptsbun run validate:mdx(600 pages)git diff --checkSummary by CodeRabbit