refactor(git): principled way to set git configuration for agents & re-enable git settings in UI #10293

xingyaoww · 2025-08-13T16:31:59Z

This change is worth documenting at https://docs.all-hands.dev/
Include this change in the Release Notes. If checked, you must provide an end-user friendly description for your change below

End-user friendly description of the problem this fixes or functionality this introduces.

refactor(git): principled way to set git configuration for agents;

Fixes a bug where git operations (like commits and pushes) would fail in warm runtimes due to missing git user configuration. This ensures that git commands work reliably in all runtime scenarios, including reused warm runtimes.

Summarize what the PR does, explaining any non-trivial design decisions.

This PR fixes a critical bug in the warm runtime system where git configuration was being lost when warm runtimes were claimed and reused.

Problem: Git configuration was set during action execution server initialization, but warm runtimes bypass this initialization step. When a warm runtime was claimed, the git user settings were missing, causing git operations to fail.

Solution: Move git configuration from the action execution server to the runtime client, ensuring git settings are applied after every runtime connection.

Key Changes:

Removed git config from ActionExecutor: Eliminated git parameters and configuration commands from the action execution server
Added git config to Runtime base class: New setup_git_config() method handles platform-specific git configuration
Updated all runtime implementations: Local, Remote, Kubernetes, CLI, and Docker runtimes now call git config setup after connection

Technical Details:

Maintains platform-specific logic (Windows PowerShell vs Unix bash, local file-based vs global config)
Uses CmdRunAction to execute git config commands in the runtime environment
Includes proper error handling and logging for failed git commands
Backward compatible with no changes to external APIs

Workflow Fix:

Before: Git config set during server startup → lost in warm runtimes → git operations fail
After: Git config applied after every runtime connection → works for both fresh and warm runtimes

Screenshots:

Before setting anything in UI:

After setting (this pr also adjust the fontsize so it follow existing setting convention in LLM tab:

It is working

In CLI - does override user config:

Link of any specific issues this addresses:

This addresses the warm runtime git configuration bug reported in the deploy repository where git operations would fail when using warm runtimes due to missing user configuration. This is why #9942 didn't work

@xingyaoww can click here to continue refining the PR

To run this PR locally, use the following command:

GUI with Docker:

docker run -it --rm   -p 3000:3000   -v /var/run/docker.sock:/var/run/docker.sock   --add-host host.docker.internal:host-gateway   -e SANDBOX_RUNTIME_CONTAINER_IMAGE=docker.all-hands.dev/all-hands-ai/runtime:a65fb44-nikolaik   --name openhands-app-a65fb44   docker.all-hands.dev/all-hands-ai/openhands:a65fb44

CLI with uvx:

uvx --python 3.12 --from git+https://github.com/All-Hands-AI/OpenHands@fix-git-config-warm-runtime openhands

- Move git config from action execution server to runtime client - Add setup_git_config() method to Runtime base class - Update all runtime implementations to call git config after connection - Remove git parameters from ActionExecutor and startup commands - Ensure git config works for both fresh and warm runtimes This fixes the bug where git operations would fail in warm runtimes because git configuration was lost when warm runtimes were claimed.

- Replace environment variable check with explicit is_local_runtime parameter - Local and CLI runtimes pass is_local_runtime=True - Remote, Kubernetes, and Docker runtimes use default is_local_runtime=False - Cleaner and more explicit runtime type detection - Updated documentation to reflect the change

- Replace is_local_runtime with is_cli_runtime parameter - CLI runtime now skips git config to preserve user's local settings - Local runtime detection uses class name instead of parameter - CLI runtime runs on user's machine and should respect existing git config - Other runtimes (Local, Remote, Kubernetes, Docker) continue to set git config - Updated documentation to reflect CLI runtime behavior

- All runtimes (Local, Remote, Kubernetes, Docker) now use global git config - Removed complex platform-specific file-based config logic - CLI runtime still skips git config to preserve user settings - Simpler and more consistent approach across all runtime types - Remove documentation from git tracking

- Update global config with git_user_name and git_user_email from settings - Apply git configuration to all active runtimes when git settings are updated - Update session config to ensure consistency across runtime operations - Add error handling and logging for git configuration updates This completes the nested runtime settings workflow: 1. Warm runtime starts without git configuration (deploy repo change) 2. User settings sent via POST /api/settings when runtime is claimed 3. Git configuration now applied immediately to the runtime 4. All subsequent commits use correct user identity Fixes the issue where user git settings were received but not applied to the runtime's git configuration. Co-authored-by: openhands <openhands@all-hands.dev>

xingyaoww · 2025-08-13T17:12:35Z

openhands/runtime/action_execution_server.py

-            INIT_COMMANDS.append(
-                f'git config --global user.email "{self.git_user_email}"'
-            )
+        # Git configuration is now handled by the runtime client after connection


Suggested change

# Git configuration is now handled by the runtime client after connection

- Chain git config commands together for efficiency (single cmd run instead of two) - Simplify settings route by removing complex session update logic - Remove documentation file and .gitignore entry as requested - Git configuration will be applied when new sessions are initialized This maintains the core functionality while making the code cleaner and more efficient. Co-authored-by: openhands <openhands@all-hands.dev>

tofarr

Nice - setting the git user and email as part of the settings makes sense

- Git configuration now happens automatically during setup_initial_env() - Removed all manual setup_git_config() calls from runtime implementations - CLI runtime sets is_cli_runtime flag to skip git configuration - Simplified git configuration workflow for all runtime types Co-authored-by: openhands <openhands@all-hands.dev>

openhands-ai · 2025-08-13T18:13:19Z

Looks like there are a few issues preventing this PR from being merged!

GitHub Actions are failing:
- Lint
- Run Python Tests
- Docker

If you'd like me to help, just leave a comment, like

@OpenHands please fix the failing actions on PR #10293 at branch fix-git-config-warm-runtime

Feel free to include any additional details that might help me get this PR into a better state.

_{^{You can manage your notification settings}}

Co-authored-by: openhands <openhands@all-hands.dev>

openhands/cli/main.py

enyst · 2025-08-13T18:47:02Z

openhands/runtime/base.py

+        git_user_email = self.config.git_user_email
+
+        # Skip git configuration for CLI runtime to preserve user's local git settings
+        is_cli_runtime = self.config.runtime == 'cli'


Should this special case include ‘local’ too? Or the local nested needs it set… hmm, globally?

yeah - basically local nested runtime needs it set :(

enyst

I liked the other option too, sending git user/email in the RecallObs, but this is okay too.

It does seem to mean that if users use ‘local’ runtime, their global git config will be overwritten, though?

xingyaoww · 2025-08-13T18:54:11Z

It does seem to mean that if users use ‘local’ runtime, their global git config will be overwritten, though?

@enyst yes.. but now with CLI, i wonder if there's an actual use case for the standalone usage of local runtime though?

- Updated test_git_config_in_command_generation to test_git_config_not_in_command_generation - Updated test_git_config_with_special_characters to test_git_config_with_special_characters_not_in_command - Tests now correctly verify that git config is NOT passed as command-line arguments - Git configuration is handled by runtime base class via git config commands, not CLI args - All git config tests now pass (5/5) Co-authored-by: openhands <openhands@all-hands.dev>

enyst · 2025-08-13T19:12:50Z

It does seem to mean that if users use ‘local’ runtime, their global git config will be overwritten, though?

@enyst yes.. but now with CLI, i wonder if there's an actual use case for the standalone usage of local runtime though?

That's a good point, except for Windows... I don't know if CLI works well on Windows
Cc: @li-boxuan

xingyaoww · 2025-08-13T19:15:46Z

@enyst happy to fix it follow-up PR if i eventually break it on windows.. But on the other hand, if CLI breaks on Windows, we should just fix the CLI, right 😄

- Removed '.git_config' assertions from test_multiple_multiline_commands and test_multi_cmd_run_in_single_line - Git configuration is now handled by runtime base class via git config commands, not by creating .git_config files - Windows tests now correctly reflect current architecture where git config is not stored as workspace files - Tests focus on command execution functionality rather than git file presence Co-authored-by: openhands <openhands@all-hands.dev>

li-boxuan · 2025-08-13T20:32:45Z

It does seem to mean that if users use ‘local’ runtime, their global git config will be overwritten, though?

@enyst yes.. but now with CLI, i wonder if there's an actual use case for the standalone usage of local runtime though?

Yes, headless mode with local runtime is how OpenHands works in terminal-bench harness. That being said, if openhands-cli can be made fully autonomous (non-interactive), I guess headless mode can be deprecated.

CLI worked on windows when I used it last time so I don’t think windows will be a concern.

…e-enable git settings in UI (#10293) Co-authored-by: openhands <openhands@all-hands.dev>

mintlify bot deployed to staging - docs August 13, 2025 16:32 View deployment

mintlify bot deployed to staging - docs August 13, 2025 16:41 View deployment

mintlify bot deployed to staging - docs August 13, 2025 16:44 View deployment

mintlify bot deployed to staging - docs August 13, 2025 16:45 View deployment

xingyaoww commented Aug 13, 2025

View reviewed changes

xingyaoww changed the title ~~Fix git configuration for warm runtime bug~~ refactor(git): principled way to set git configuration for agents Aug 13, 2025

tofarr approved these changes Aug 13, 2025

View reviewed changes

xingyaoww added 2 commits August 13, 2025 14:19

simplify impl

8cda62d

enable git user setting in ui

b5b42b5

xingyaoww changed the title ~~refactor(git): principled way to set git configuration for agents~~ refactor(git): principled way to set git configuration for agents & re-enable git settings in UI Aug 13, 2025

xingyaoww and others added 3 commits August 13, 2025 14:37

Empty commit

da6bb28

Co-authored-by: openhands <openhands@all-hands.dev>

standardize app setting

d1073ca

fix lint

0883023

xingyaoww marked this pull request as ready for review August 13, 2025 18:42

xingyaoww requested a review from amanape as a code owner August 13, 2025 18:42

enyst reviewed Aug 13, 2025

View reviewed changes

openhands/cli/main.py Outdated Show resolved Hide resolved

enyst reviewed Aug 13, 2025

View reviewed changes

xingyaoww and others added 2 commits August 13, 2025 14:55

remove broad exception handling at the exit of cli

061a729

xingyaoww enabled auto-merge (squash) August 13, 2025 19:10

enyst mentioned this pull request Aug 13, 2025

[Refactor]: Abstract resolver's PR sending functions into class-based architecture #10295

Closed

2 tasks

xingyaoww merged commit d256348 into main Aug 13, 2025
21 of 27 checks passed

xingyaoww deleted the fix-git-config-warm-runtime branch August 13, 2025 20:45

JiseungHong added a commit to JiseungHong/OpenHands that referenced this pull request Aug 14, 2025

Apply PR All-Hands-AI#10293 - handle git_user_name & git_user_email

e961b3d

enyst pushed a commit that referenced this pull request Aug 15, 2025

refactor(git): principled way to set git configuration for agents & r…

dae9a28

…e-enable git settings in UI (#10293) Co-authored-by: openhands <openhands@all-hands.dev>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

refactor(git): principled way to set git configuration for agents & re-enable git settings in UI #10293

refactor(git): principled way to set git configuration for agents & re-enable git settings in UI #10293

Uh oh!

xingyaoww commented Aug 13, 2025 •

edited by github-actions bot

Loading

Uh oh!

xingyaoww Aug 13, 2025

Uh oh!

tofarr left a comment

Uh oh!

openhands-ai bot commented Aug 13, 2025

Uh oh!

Uh oh!

enyst Aug 13, 2025

Uh oh!

xingyaoww Aug 13, 2025

Uh oh!

enyst left a comment

Uh oh!

xingyaoww commented Aug 13, 2025

Uh oh!

enyst commented Aug 13, 2025

Uh oh!

xingyaoww commented Aug 13, 2025

Uh oh!

li-boxuan commented Aug 13, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

pFad - (p)hone/(F)rame/(a)nonymizer/(d)eclutterfier! Saves Data!

refactor(git): principled way to set git configuration for agents & re-enable git settings in UI #10293

refactor(git): principled way to set git configuration for agents & re-enable git settings in UI #10293

Uh oh!

Conversation

xingyaoww commented Aug 13, 2025 • edited by github-actions bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

xingyaoww Aug 13, 2025

Choose a reason for hiding this comment

Uh oh!

tofarr left a comment

Choose a reason for hiding this comment

Uh oh!

openhands-ai bot commented Aug 13, 2025

Uh oh!

Uh oh!

enyst Aug 13, 2025

Choose a reason for hiding this comment

Uh oh!

xingyaoww Aug 13, 2025

Choose a reason for hiding this comment

Uh oh!

enyst left a comment

Choose a reason for hiding this comment

Uh oh!

xingyaoww commented Aug 13, 2025

Uh oh!

enyst commented Aug 13, 2025

Uh oh!

xingyaoww commented Aug 13, 2025

Uh oh!

li-boxuan commented Aug 13, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

pFad - (p)hone/(F)rame/(a)nonymizer/(d)eclutterfier! Saves Data!

xingyaoww commented Aug 13, 2025 •

edited by github-actions bot

Loading