Skip to content

fix(ci): use setup-python version for pipenv virtualenv#1195

Merged
Strift merged 1 commit intomeilisearch:mainfrom
VedantMadane:fix/doc-build-python-version
Jan 20, 2026
Merged

fix(ci): use setup-python version for pipenv virtualenv#1195
Strift merged 1 commit intomeilisearch:mainfrom
VedantMadane:fix/doc-build-python-version

Conversation

@VedantMadane
Copy link
Contributor

@VedantMadane VedantMadane commented Jan 15, 2026 •
edited by coderabbitai bot
Loading

Summary

Fixes #1193 - The documentation workflow was failing.

Problem

The documentation workflow failed because pipenv was using the system Python 3.12.3 instead of the Python 3.10 installed by actions/setup-python. This caused an ImportError when pipdeptree tried to run in the virtualenv with a different Python version:

ImportError: cannot import name 'InterpreterQueryError' from 'pipenv.vendor.pipdeptree._discovery'

Solution

Explicitly specify --python $(which python) when creating the pipenv virtualenv to ensure it uses the Python version installed by actions/setup-python.

Testing

The fix ensures the virtualenv uses Python 3.10 as intended by the workflow configuration.

Summary by CodeRabbit

Release Notes

  • Chores
    • Enhanced the documentation build workflow to explicitly configure the Python interpreter during dependency installation. This improvement ensures more reliable and consistent documentation builds across different development and deployment environments by properly specifying which Python version is used throughout the entire dependency resolution and installation process.

✏️ Tip: You can customize this high-level summary in your review settings.

@VedantMadane
fix(ci): use setup-python version for pipenv virtualenv
16530b7 
The documentation workflow was failing because pipenv was using
the system Python 3.12 instead of the Python 3.10 installed by
actions/setup-python. This caused an ImportError when pipdeptree
tried to run in the virtualenv with a different Python version.

Fix by explicitly specifying --python  to ensure
pipenv creates the virtualenv with the correct Python version.

Fixes meilisearch#1193

Signed-off-by: Vedant Madane <[email protected]>
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 15, 2026 •
edited
Loading

📝 Walkthrough

Walkthrough

The GitHub Actions documentation workflow has been updated to explicitly specify the Python interpreter when installing dependencies via Pipenv. The command now includes $(which python) to ensure Pipenv uses the currently active Python binary during installation.

Changes

Cohort / File(s) Summary
GitHub Actions Workflow Configuration
\.github/workflows/documentation\.yml		 Updated Pipenv install command to explicitly specify Python interpreter using $(which python) to resolve documentation build failures

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A Python path, once lost in the haze,
Now whispers its location through workflow's ways,
Pipenv knows where to find the right one,
Docs build with joy when the deed is done! 📚✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: explicitly specifying the Python interpreter for pipenv in the CI workflow to use the setup-python version.
Linked Issues check ✅ Passed The PR directly addresses issue #1193 by fixing the documentation build through explicit Python version specification for pipenv, ensuring Python 3.10 compatibility and resolving the ImportError.
Out of Scope Changes check ✅ Passed The change is narrowly scoped to the documentation workflow file, modifying only the pipenv install command to use the correct Python version as required by issue #1193.
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.

🧹 Recent nitpick comments
.github/workflows/documentation.yml (1)

43-47: Good fix for the Python version mismatch.

The --python $(which python) flag correctly ensures pipenv creates its virtualenv using the Python 3.10 binary from actions/setup-python rather than auto-detecting the system Python. This properly addresses the ImportError caused by the version mismatch.

Optional: Consider consolidating the package installations into a single command for slightly faster execution:

♻️ Suggested consolidation (optional) 
      - name: Install dependencies
        run: |
-          pipenv --python $(which python) install --dev
-          pipenv install sphinx
-          pipenv install sphinx_rtd_theme
+          pipenv --python $(which python) install --dev sphinx sphinx_rtd_theme
📜 Recent review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6003393 and 16530b7.

📒 Files selected for processing (1)
  • .github/workflows/documentation.yml

✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.

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.

@Strift Strift added the maintenance Anything related to maintenance (CI, tests, refactoring...) label Jan 20, 2026
Strift
Strift approved these changes Jan 20, 2026
View reviewed changes
Copy link
Contributor

@Strift Strift left a comment

Choose a reason for hiding this comment

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

Hello @VedantMadane and thanks for this quick fix 🙌

@Strift Strift added this pull request to the merge queue Jan 20, 2026
Merged via the queue into meilisearch:main with commit 01dfab3 Jan 20, 2026
11 checks passed
@Strift Strift mentioned this pull request Jan 20, 2026
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Strift Strift Strift approved these changes

Assignees

No one assigned

Labels

maintenance Anything related to maintenance (CI, tests, refactoring...)

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Fix documentation build

2 participants

@VedantMadane @Strift