Skip to content

docs(docs): preserve quoted values when loading test env files - #6693

Open
jabrailkhalil wants to merge 2 commits into
Agenta-AI:mainfrom
jabrailkhalil:docs/test-env-file-loading
Open

docs(docs): preserve quoted values when loading test env files#6693
jabrailkhalil wants to merge 2 commits into
Agenta-AI:mainfrom
jabrailkhalil:docs/test-env-file-loading

Conversation

@jabrailkhalil

Copy link
Copy Markdown

Summary

The testing guide's export $(... | xargs) fallback splits quoted environment values. For example, AGENTA_AUTH_KEY="synthetic key with spaces" becomes just synthetic. The guide now uses the Python runners' existing --env-file option, with the correct relative paths for API, services, and SDK contributors.

Testing

Verified locally

  • Reproduced value truncation with the old shell command using a synthetic fixture.
  • Invoked the actual API, services, and SDK runner CLIs with the fixture. All three preserved the full value before dispatching pytest; the pytest subprocess was mocked, so this is an environment-loading check, not an application test run.
  • npm run build in docs/: passed with Node 22.21.1 and dependencies installed using pinned pnpm 10.30.0. Existing redirect/deprecation warnings remain.
  • git diff --check: passed.

Added or updated tests

No permanent tests added for this documentation-only correction.

QA follow-up

No live application stack or production credentials were used.

Demo

N/A: documentation-only command correction, no UI behavior change.

Checklist

  • Demo is marked N/A for this documentation-only change.
  • Relevant environment-loading checks pass locally.
  • Documentation formatting follows the existing page; whitespace check passes.
  • CLA status to be checked after submission.

Contributor Resources

Contributing guide

Copilot AI lite review requested due to automatic review settings September 8, 2026 20:47

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@vercel

vercel Bot commented Sep 8, 2026

Copy link
Copy Markdown

@jabrailkhalil is attempting to deploy a commit to the agenta projects Team on Vercel.

A member of the Team first needs to authorize it.

@CLAassistant

CLAassistant commented Sep 8, 2026

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@coderabbitai

coderabbitai Bot commented Sep 8, 2026

Copy link
Copy Markdown
Contributor

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository YAML (base), Organization UI (inherited)

Review profile: CHILL

Plan: Advanced

Run ID: 3b1236dc-e79b-4c2e-a2bb-ce71a0321067

📥 Commits

Reviewing files that changed from the base of the PR and between 09d37c3 and eb50b9a.

📒 Files selected for processing (1)
  • docs/docs/contributing/guides/testing.mdx
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/docs/contributing/guides/testing.mdx

Included review availability: Your plan provides up to 8 included reviews per hour; 7 remain after this review.


📝 Summary

Summary by CodeRabbit

  • Documentation
    • Updated testing guidance to require unsetting exported AGENTA_API_URL and AGENTA_AUTH_KEY before using --env-file.
    • Clarified that existing environment variables take precedence over values loaded from the selected environment file.
    • Updated the example command to reflect the correct environment-variable loading order.

Walkthrough

The testing guide now explains that exported AGENTA_API_URL and AGENTA_AUTH_KEY values take precedence over --env-file. It adds an unset command before the API runner example.

Changes

Testing documentation

Layer / File(s) Summary
Environment file precedence guidance
docs/docs/contributing/guides/testing.mdx
The guide documents environment variable precedence, adds an unset command for exported API settings, and retains guidance for SDK and service runners and quoted values.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~3 minutes

Merge Risk: ⚪ Minimal · up to eb50b

The testing guide update documents environment-file usage and variable precedence without any identified remaining merge-readiness risk.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly describes the main documentation change: preserving quoted environment values when loading test environment files.
Description check ✅ Passed The description directly explains the documentation correction, affected runner commands, verification steps, and testing scope.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches 💡 1
🛠️ Fix failing CI checks 💡
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1


ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository YAML (base), Organization UI (inherited)

Review profile: CHILL

Plan: Advanced

Run ID: babcec14-27e2-4e7c-acdb-e81a89413f27

📥 Commits

Reviewing files that changed from the base of the PR and between ab74027 and 09d37c3.

📒 Files selected for processing (1)
  • docs/docs/contributing/guides/testing.mdx

Included review availability: Your plan provides up to 8 included reviews per hour; 7 remain after this review.

Comment thread docs/docs/contributing/guides/testing.mdx
Copilot AI review requested due to automatic review settings September 8, 2026 22:45

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

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.

3 participants