feat: Pass additional environment variables to shell execution
Summary
This PR updates the getSanitizedEnv function to pass additional GitHub Action-related environment variables and any environment variables prefixed with GEMINI_CLI_ to shell execution.
Details
The getSanitizedEnv function in packages/core/src/services/shellExecutionService.ts has been modified to enhance the environment available to spawned shell commands, particularly in GitHub environments. This change ensures that critical GitHub Action context variables (such as ADDITIONAL_CONTEXT, BRANCH_NAME, EVENT_NAME, etc.) are explicitly included. Additionally, any custom secrets or environment variables defined with the GEMINI_CLI_ prefix will now be automatically passed through, providing more flexibility for integrations and secure secret management. This change is crucial for scenarios where shell commands rely on these specific environment variables for their correct operation or for accessing sensitive information in a controlled manner.
Related Issues
None directly.
How to Validate
- Inspect the
packages/core/src/services/shellExecutionService.tsfile to confirm the additions of GitHub Action environment variables to theessentialVarsarray and the inclusion ofGEMINI_CLI_*prefixed variables in thegetSanitizedEnvfunction. - Run the preflight checks to ensure no regressions were introduced:
npm run preflight - Confirm that all tests pass.
Pre-Merge Checklist
- [ ] Updated relevant documentation and README (if needed)
- [ ] Added/updated tests (if needed) - Changes verified by existing
npm run preflighttests. - [ ] Noted breaking changes (if any)
- [ ] Validated on required platforms/methods:
- [x] MacOS
- [x] npm run
- [ ] npx
- [ ] Docker
- [ ] Podman
- [ ] Seatbelt
- [ ] Windows
- [ ] npm run
- [ ] npx
- [ ] Docker
- [ ] Linux
- [ ] npm run
- [ ] npx
- [ ] Docker
- [x] MacOS
Summary of Changes
Hello @galz10, I'm Gemini Code Assist[^1]! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request refines the getSanitizedEnv function to enrich the environment variables passed to shell executions. The primary goal is to ensure that critical GitHub Action context variables are consistently available and to provide a more flexible mechanism for including custom environment variables prefixed with GEMINI_CLI_. This enhancement supports better integration within GitHub environments and facilitates secure management of sensitive information.
Highlights
- GitHub Action Environment Variables: The
getSanitizedEnvfunction now explicitly includes a comprehensive list of GitHub Action-related environment variables, such asADDITIONAL_CONTEXT,BRANCH_NAME,EVENT_NAME, andPULL_REQUEST_NUMBER, ensuring they are available to spawned shell commands. - Expanded
GEMINI_CLI_Variable Inclusion: The logic for passing environment variables has been updated to include all variables prefixed withGEMINI_CLI_, rather than justGEMINI_CLI_TESTvariables. This change allows for greater flexibility in passing custom secrets and configuration.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in pull request comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with :thumbsup: and :thumbsdown: on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
[^1]: Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.
Size Change: +343 B (0%)
Total Size: 22 MB
ℹ️ View Unchanged
| Filename | Size | Change |
|---|---|---|
./bundle/gemini.js |
22 MB | +343 B (0%) |
./bundle/sandbox-macos-permissive-closed.sb |
1.03 kB | 0 B |
./bundle/sandbox-macos-permissive-open.sb |
890 B | 0 B |
./bundle/sandbox-macos-permissive-proxied.sb |
1.31 kB | 0 B |
./bundle/sandbox-macos-restrictive-closed.sb |
3.29 kB | 0 B |
./bundle/sandbox-macos-restrictive-open.sb |
3.36 kB | 0 B |
./bundle/sandbox-macos-restrictive-proxied.sb |
3.56 kB | 0 B |