Skip to content

Sync embedding delay#294

Merged
steven-tey merged 1 commit intomainfrom
sync-embeddings-delay
Mar 5, 2026
Merged

Sync embedding delay#294
steven-tey merged 1 commit intomainfrom
sync-embeddings-delay

Conversation

@pepeladeira
Copy link
Copy Markdown
Collaborator

@pepeladeira pepeladeira commented Mar 5, 2026

Summary by CodeRabbit

  • Documentation

    • Updated image accessibility text in partner rewards article.
  • Chores

    • Added deployment timing buffer to documentation synchronization workflow.

@pepeladeira pepeladeira marked this pull request as ready for review March 5, 2026 19:07
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Mar 5, 2026

📝 Walkthrough

Walkthrough

Added a 600-second pause to the CI/CD workflow after identifying changed MDX files, allowing deployment to complete before re-embedding articles. Updated image alt text in documentation by adding a trailing period for consistency.

Changes

Cohort / File(s) Summary
CI/CD Workflow
.github/workflows/sync-embeddings.yml
Added "Wait for Mintlify to deploy" step with 600-second sleep, positioned between file detection and re-embedding stages, conditional on MDX file changes.
Documentation Alt Text
help/article/partner-rewards.mdx
Updated image alt text punctuation: added trailing period to "Partner profile page group history."

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

🐰 A workflow now waits, patient and true,
Six hundred seconds for Mintlify to brew,
While words get their dots in the proper place,
Each change a small step in the embedding's embrace!

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'Sync embedding delay' directly matches the main purpose of the PR - adding a wait step (600 second delay) to the sync-embeddings workflow before re-embedding articles.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch sync-embeddings-delay

Tip

Try Coding Plans. Let us write the prompt for your AI agent so you can ship faster (with fewer bugs).
Share your feedback on Discord.


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.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

🧹 Nitpick comments (1)
.github/workflows/sync-embeddings.yml (1)

27-30: Make deploy wait configurable instead of hard-coding 600 seconds.

This works, but hard-coding the delay makes operational tuning slower and forces code changes for every adjustment.

♻️ Suggested tweak
       - name: Wait for Mintlify to deploy
         if: steps.changed.outputs.files != ''
-        run: sleep 600
+        env:
+          MINTLIFY_DEPLOY_WAIT_SECONDS: 600
+        run: |
+          echo "Waiting ${MINTLIFY_DEPLOY_WAIT_SECONDS}s for Mintlify deploy..."
+          sleep "${MINTLIFY_DEPLOY_WAIT_SECONDS}"
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In @.github/workflows/sync-embeddings.yml around lines 27 - 30, Replace the
hard-coded sleep 600 in the "Wait for Mintlify to deploy" step with a
configurable environment/input variable (e.g., DEPLOY_WAIT) and use a shell
fallback so operators can override without code changes; for example, add an env
or workflow input named DEPLOY_WAIT with default 600 and change the step's run
to use bash fallback like sleep "${{ env.DEPLOY_WAIT:-600 }}" (keep the existing
if: steps.changed.outputs.files != '' condition).
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In @.github/workflows/sync-embeddings.yml:
- Around line 27-30: Replace the hard-coded sleep 600 in the "Wait for Mintlify
to deploy" step with a configurable environment/input variable (e.g.,
DEPLOY_WAIT) and use a shell fallback so operators can override without code
changes; for example, add an env or workflow input named DEPLOY_WAIT with
default 600 and change the step's run to use bash fallback like sleep "${{
env.DEPLOY_WAIT:-600 }}" (keep the existing if: steps.changed.outputs.files !=
'' condition).

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 2b14f5bb-76c7-405f-a022-8c321def4da3

📥 Commits

Reviewing files that changed from the base of the PR and between 2892e70 and 74c72d1.

📒 Files selected for processing (2)
  • .github/workflows/sync-embeddings.yml
  • help/article/partner-rewards.mdx

@steven-tey steven-tey merged commit 8fad260 into main Mar 5, 2026
4 checks passed
@steven-tey steven-tey deleted the sync-embeddings-delay branch March 5, 2026 19:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants