Merge branch 'main' of https://github.com/intersystems/git-source-control into default-mappings-healthshare

Author: isc-pbarton

CHANGELOG.md

@@ -13,12 +13,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Settings page now has option to switch namespace (#856)
 - SourceControl.Git.Settings is now documented as part of the public API to allow programmatic configuration of settings (#262)
 - Newly configured instances start with default mappings for ESD, LUT and HL7 when relevant (#724)
+- New setting to define an SSH client configuration file for connections to SSH remotes (#293)
 
 ### Fixed
 - When cloning a repo with Configure, that repo's embedded-git-config file will overwrite previous settings (#819)
 - Settings page no longer removes remote when saving after cloning (#858)
 - Always set the remote as the upstream branch when pushing (#871)
 - Fixed import of HL7 and LUT files added at the same time as their mappings (#864)
+- Fixed issue where Git's interactive credential manager causes Git push/pull/fetch to hang (#235)
 
 ## [2.13.1] - 2025-09-16
 

README.md

@@ -14,14 +14,13 @@ Embedded Git support for InterSystems platforms, supporting unified source contr
     ```
     zpm "install git-source-control"
     ```
-    To install on an environment without access to the internet, download the tar.gz file from the [releases](https://github.com/intersystems/git-source-control/releases) page. Copy the archive onto a file system the IRIS instance has access to and extract it. Use the package manager to load the release from that directory.
+    To install on an environment without access to the internet, download the tar.gz file from the [releases](https://github.com/intersystems/git-source-control/releases) page. Copy it into a directory accessible to the IRIS instance and use a command in the IRIS terminal to install from the tar.gz file.
     ```
-    tar -xf /path/to/archive/git-source-control-release.tar.gz
-    zpm "load /path/to/archive/git-source-control-release"
+    zpm "load /path/to/archive/git-source-control-release.tar.gz"
     ```
 2. Configure settings by running the following method and answering the prompts:
    ```
-   d ##class(SourceControl.Git.API).Configure()
+   do ##class(SourceControl.Git.API).Configure()
    ```
    This will also allow you to generate an SSH key for use as (e.g.) a deploy key and to initialize or clone a git repo.
 3. If using VSCode: Set up `isfs` server-side editing. First, save your current workspace in which you have the code open. Then, open the `.code-workspace` file generated by VS Code and add the following to the list of folders:

cls/SourceControl/Git/Settings.cls

@@ -93,6 +93,9 @@ Property Mappings [ MultiDimensional ];
 /// (user-level) List of namespaces on this instance to include Embedded Git links in the SMP favorites
 Property favoriteNamespaces As %DynamicArray;
 
+/// (Optional) Path to an SSH client configuration file for use with SSH connections to a Git remote
+Property sshConfigFile As %String(MAXLEN = "") [ InitialExpression = {##class(SourceControl.Git.Utils).SSHConfigFile()} ];
+
 Method %OnNew() As %Status
 {
     set mappingsNode = ##class(SourceControl.Git.Utils).MappingsNode()
@@ -183,6 +186,7 @@ Method %Save() As %Status
     set @storage@("settings", "environmentName") = ..environmentName
     set @storage@("settings", "lockBranch") = ..lockBranch
     set @storage@("settings", "mappingsToken") = ..mappingsToken
+    set @storage@("settings", "sshConfigFile") = ..sshConfigFile
     if ..basicMode = "system" {
         kill @storage@("settings", "user", $username, "basicMode")
     } else {
@@ -551,3 +555,4 @@ Method SaveDefaults() As %Boolean
 }
 
 }
+

cls/SourceControl/Git/Utils.cls

@@ -195,6 +195,11 @@ ClassMethod MappingsToken() As %String
     quit $get(@..#Storage@("settings","mappingsToken"),"")
 }
 
+ClassMethod SSHConfigFile() As %String
+{
+    quit $get(@..#Storage@("settings","sshConfigFile"),"")
+}
+
 ClassMethod IsLIVE() As %Boolean
 {
     quit ..EnvironmentName()="LIVE"
@@ -1896,8 +1901,14 @@ ClassMethod RunGitCommandWithInput(command As %String, inFile As %String = "", O
                 set privateKeyFile = $replace(privateKeyFile,"\","\\")
             }
             set newArgs($increment(newArgs)) = "-c"
+            set sshConfigFile = ..SSHConfigFile()
+            if sshConfigFile="" {
+                set sshConfigFile = "/dev/null"
+            } elseif $$$isWINDOWS {
+                set sshConfigFile = $replace(sshConfigFile,"\","\\")
+            }
             // StrictHostKeyChecking=accept-new for good behavior on first connection
-            set newArgs($increment(newArgs)) = "core.sshCommand=ssh -F /dev/null -o StrictHostKeyChecking=accept-new -i "_privateKeyFile
+            set newArgs($increment(newArgs)) = "core.sshCommand=ssh -F "_sshConfigFile_" -o StrictHostKeyChecking=accept-new -i "_privateKeyFile
         }
 
         set username = ""
@@ -1912,6 +1923,8 @@ ClassMethod RunGitCommandWithInput(command As %String, inFile As %String = "", O
         set newArgs($increment(newArgs)) = "user.name="_username
         set newArgs($increment(newArgs)) = "-c"
         set newArgs($increment(newArgs)) = "user.email="_email
+        set newArgs($increment(newArgs)) = "-c"
+        set newArgs($increment(newArgs)) = "credential.interactive=false"
     }
 
     set newArgs($increment(newArgs)) = command

csp/gitprojectsettings.csp

@@ -120,7 +120,7 @@ body {
 
         if ('settings.settingsUIReadOnly) {
             do ##class(SourceControl.Git.Utils).Locked($get(%request.Data("lockNamespace",1)))
-            for param="gitBinPath","namespaceTemp","privateKeyFile","pullEventClass","percentClassReplace", "defaultMergeBranch","environmentName","mappingsToken" {
+            for param="gitBinPath","namespaceTemp","privateKeyFile","pullEventClass","percentClassReplace", "defaultMergeBranch","environmentName","mappingsToken","sshConfigFile" {
                 set $Property(settings,param) = $Get(%request.Data(param,1))
             }
 
@@ -395,6 +395,13 @@ body {
         }
         </server>
 
+        <div class="form-group row mb-3">
+            <label for="sshConfigFile" class="offset-sm-1 col-sm-3 col-form-label"  data-toggle="tooltip" data-placement="top" title="(Optional) Path to an SSH client configuration file for use with SSH connections to a Git remote">Path to SSH Config File</label>
+            <div class="col-sm-7">
+                <input type="text" class="form-control" id="sshConfigFile" name="sshConfigFile" value='#(..EscapeHTML(settings.sshConfigFile))#' placeholder=""/>
+            </div>
+        </div>
+
         <div class="form-group row mb-3">
             <label for="pullEventClass" class="offset-sm-1 col-sm-3 col-form-label"  data-toggle="tooltip" data-placement="top" title="Handler class for git pull"><b>Pull Event Class</b></label>
             <div class="col-sm-7">