[Bug Report] Issue with ESP-IDF Installation - if git signature name or email contains '<', '>' or \n (EIM-667)

[bewster]

System Information

• OS info: OS: Windows 11 (22621) | Architecture: x86_64 | Kernel: 22621
• App Version: 0.8.5

Description

The ESP-IDF Installation Manager returns a generic error message, so it is impossible to determine the cause.

Steps to Reproduce

1. Edit .gitconfig so user.name ends with "\n".
2. Start Easy Installation.

Expected Behavior

Installer should give a more helpful error message.

Actual Behavior

The UI response is:

Error Details:

Installation failed with exit code: 1

Logs

eim.log
eim_gui.log

Additional Information

After understanding that this application uses the gix module, I was able to test cloning with the gix binary, https://github.com/GitoxideLabs/gitoxide/releases/download/v0.52.0/gitoxide-lean-v0.52.0-x86_64-pc-windows-msvc.zip. This yielded the following error messages:

Error: Failed to update references to their new position to match their remote locations

Caused by:
    0: The reflog could not be created or updated
    1: Could not open reflog file at "..." for appending
    2: Signature name or email must not contain '<', '>' or \n: My Name

The eim.log includes the Error message, but it would be extremely helpful if the EIM could also include the "Caused by:" messages.

[dcode]

removing < and > from the email line in ~/.gitconfig fixed this for me. Wrapping the email in <> is the common convention, though. Any user that configured git using the gh cli, for example, will run into this issue.