Skip to content

refactor: change venv activation#5463

Merged
Weves merged 2 commits intomainfrom
adjust-instructions
Sep 23, 2025
Merged

refactor: change venv activation#5463
Weves merged 2 commits intomainfrom
adjust-instructions

Conversation

@Weves
Copy link
Contributor

@Weves Weves commented Sep 20, 2025

Description

^

How Has This Been Tested?

[Describe the tests you ran to verify your changes]

Backporting (check the box to trigger backport action)

Note: You have to check that the action passes, otherwise resolve the conflicts manually and tag the patches.

  • This PR should be backported (make sure to check that the backport attempt succeeds)
  • [Optional] Override Linear Check

@vercel
Copy link

vercel bot commented Sep 20, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
internal-search Ready Ready Preview Comment Sep 20, 2025 11:51pm

@Weves Weves changed the title Change venv activation refactor: change venv activation Sep 20, 2025
@Weves Weves marked this pull request as ready for review September 21, 2025 00:01
@Weves Weves requested a review from a team as a code owner September 21, 2025 00:01
Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

Greptile Summary

This PR standardizes virtual environment activation instructions across the project documentation. The changes update three documentation files (AGENTS.md, CLAUDE.md, and CONTRIBUTING.md) to use consistent virtual environment activation commands.

The main changes include:

  • AGENTS.md and CLAUDE.md: Changed from workon onyx && to source backend/.venv/bin/activate for virtual environment activation
  • CONTRIBUTING.md: Removed a warning note about avoiding virtual environment setup within the onyx directory for IDE compatibility

These changes align the documentation with the project's standard Python venv setup process documented in CONTRIBUTING.md, which creates a virtual environment using python -m venv .venv. The standardization moves away from virtualenvwrapper-specific commands (workon) to standard Python venv activation, making the instructions more universally applicable and consistent with modern Python development practices.

The changes improve developer experience by providing clear, consistent guidance across all documentation files, eliminating confusion about which virtual environment activation method to use.

Confidence score: 4/5

  • This PR is safe to merge with low risk of breaking functionality
  • Score reflects documentation-only changes that improve consistency but removes potentially useful IDE guidance
  • Pay attention to formatting issue in CLAUDE.md where line continuation may need adjustment

3 files reviewed, 1 comment

Edit Code Review Bot Settings | Greptile

Comment on lines +7 to 8
- If you run into any missing python dependency errors, try running your command with `source backend/.venv/bin/activate` \
to assume the python venv.
Copy link
Contributor

Choose a reason for hiding this comment

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

syntax: Line continuation formatting is incorrect. The backslash should be at the end of line 7 without a space, and line 8 should continue the sentence properly.

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.

1 issue found across 3 files

Prompt for AI agents (all 1 issues)

Understand the root cause of the following 1 issues and fix them.


<file name="AGENTS.md">

<violation number="1" location="AGENTS.md:7">
Virtualenv activation path is inconsistent with CONTRIBUTING.md; use source .venv/bin/activate to match the documented setup.</violation>
</file>

React with 👍 or 👎 to teach cubic. Mention @cubic-dev-ai to give feedback, ask questions, or re-run the review.

## KEY NOTES

- If you run into any missing python dependency errors, try running your command with `workon onyx &&` in front
- If you run into any missing python dependency errors, try running your command with `source backend/.venv/bin/activate` \
Copy link
Contributor

@cubic-dev-ai cubic-dev-ai bot Sep 21, 2025

Choose a reason for hiding this comment

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

Virtualenv activation path is inconsistent with CONTRIBUTING.md; use source .venv/bin/activate to match the documented setup.

Prompt for AI agents
Address the following comment on AGENTS.md at line 7:

<comment>Virtualenv activation path is inconsistent with CONTRIBUTING.md; use source .venv/bin/activate to match the documented setup.</comment>

<file context>
@@ -4,7 +4,7 @@ This file provides guidance to Codex when working with code in this repository.
 ## KEY NOTES
 
-- If you run into any missing python dependency errors, try running your command with `workon onyx &amp;&amp;` in front
+- If you run into any missing python dependency errors, try running your command with `source backend/.venv/bin/activate` \
 to assume the python venv.
 - To make tests work, check the `.env` file at the root of the project to find an OpenAI key.
</file context>
Suggested change
- If you run into any missing python dependency errors, try running your command with `source backend/.venv/bin/activate` \
- If you run into any missing python dependency errors, try running your command with `source .venv/bin/activate` \
Fix with Cubic

@Weves Weves merged commit f9bd03c into main Sep 23, 2025
53 of 55 checks passed
@Weves Weves deleted the adjust-instructions branch September 23, 2025 23:07
razvanMiu pushed a commit to eea/danswer that referenced this pull request Oct 16, 2025
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.

1 participant