feature: support --signoff for git commit command (#591)

love-linger · love-linger · commit 06fd49ba928e · 2024-10-23T09:46:27.000+08:00
Signed-off-by: leo &lt;longshuang@msn.cn&gt;
diff --git a/src/Commands/Commit.cs b/src/Commands/Commit.cs
@@ -4,17 +4,37 @@ namespace SourceGit.Commands
 {
     public class Commit : Command
     {
-        public Commit(string repo, string message, bool amend)
+        public Commit(string repo, string message, bool amend, bool signOff)
         {
-            var file = Path.GetTempFileName();
-            File.WriteAllText(file, message);
+            _tmpFile = Path.GetTempFileName();
+            File.WriteAllText(_tmpFile, message);
 
             WorkingDirectory = repo;
             Context = repo;
             TraitErrorAsOutput = true;
-            Args = $"commit --allow-empty --file=\"{file}\"";
+            Args = $"commit --allow-empty --file=\"{_tmpFile}\"";
             if (amend)
                 Args += " --amend --no-edit";
+            if (signOff)
+                Args += " --signoff";
         }
+
+        public bool Run()
+        {
+            var succ = Exec();
+            
+            try
+            {
+                File.Delete(_tmpFile);
+            }
+            catch
+            {
+                // Ignore
+            }
+
+            return succ;
+        }
+
+        private string _tmpFile = string.Empty;
     }
 }
diff --git a/src/Models/RepositorySettings.cs b/src/Models/RepositorySettings.cs
@@ -106,6 +106,12 @@ public int AutoFetchInterval
             set;
         } = 10;
 
+        public bool EnableSignOffForCommit
+        {
+            get;
+            set;
+        } = false;
+
         public void PushCommitMessage(string message)
         {
             var existIdx = CommitMessages.IndexOf(message);
diff --git a/src/Resources/Locales/en_US.axaml b/src/Resources/Locales/en_US.axaml
@@ -143,6 +143,7 @@
   <x:String x:Key="Text.Configure.Git.AutoFetch" xml:space="preserve">Fetch remotes automatically</x:String>
   <x:String x:Key="Text.Configure.Git.AutoFetchIntervalSuffix" xml:space="preserve">Minute(s)</x:String>
   <x:String x:Key="Text.Configure.Git.DefaultRemote" xml:space="preserve">Default Remote</x:String>
+  <x:String x:Key="Text.Configure.Git.EnableSignOff" xml:space="preserve">Enable --signoff for commit</x:String>
   <x:String x:Key="Text.Configure.IssueTracker" xml:space="preserve">ISSUE TRACKER</x:String>
   <x:String x:Key="Text.Configure.IssueTracker.AddSampleGithub" xml:space="preserve">Add Sample Github Rule</x:String>
   <x:String x:Key="Text.Configure.IssueTracker.AddSampleJira" xml:space="preserve">Add Sample Jira Rule</x:String>
diff --git a/src/Resources/Locales/zh_CN.axaml b/src/Resources/Locales/zh_CN.axaml
@@ -146,6 +146,7 @@
   <x:String x:Key="Text.Configure.Git.AutoFetch" xml:space="preserve">启用定时自动拉取远程更新</x:String>
   <x:String x:Key="Text.Configure.Git.AutoFetchIntervalSuffix" xml:space="preserve">分钟</x:String>
   <x:String x:Key="Text.Configure.Git.DefaultRemote" xml:space="preserve">默认远程</x:String>
+  <x:String x:Key="Text.Configure.Git.EnableSignOff" xml:space="preserve">提交信息追加署名 (--signoff)</x:String>
   <x:String x:Key="Text.Configure.IssueTracker" xml:space="preserve">ISSUE追踪</x:String>
   <x:String x:Key="Text.Configure.IssueTracker.AddSampleGithub" xml:space="preserve">新增匹配Github Issue规则</x:String>
   <x:String x:Key="Text.Configure.IssueTracker.AddSampleJira" xml:space="preserve">新增匹配Jira规则</x:String>
diff --git a/src/Resources/Locales/zh_TW.axaml b/src/Resources/Locales/zh_TW.axaml
@@ -146,6 +146,7 @@
   <x:String x:Key="Text.Configure.Git.AutoFetch" xml:space="preserve">啟用定時自動提取 (fetch) 遠端更新</x:String>
   <x:String x:Key="Text.Configure.Git.AutoFetchIntervalSuffix" xml:space="preserve">分鐘</x:String>
   <x:String x:Key="Text.Configure.Git.DefaultRemote" xml:space="preserve">預設遠端存放庫</x:String>
+  <x:String x:Key="Text.Configure.Git.EnableSignOff" xml:space="preserve">提交資訊追加署名 (--signoff)</x:String>
   <x:String x:Key="Text.Configure.IssueTracker" xml:space="preserve">Issue 追蹤</x:String>
   <x:String x:Key="Text.Configure.IssueTracker.AddSampleGithub" xml:space="preserve">新增符合 GitHub Issue 規則</x:String>
   <x:String x:Key="Text.Configure.IssueTracker.AddSampleJira" xml:space="preserve">新增符合 Jira 規則</x:String>
diff --git a/src/ViewModels/RepositoryConfigure.cs b/src/ViewModels/RepositoryConfigure.cs
@@ -60,6 +60,12 @@ public string HttpProxy
             set => SetProperty(ref _httpProxy, value);
         }
 
+        public bool EnableSignOffForCommit
+        {
+            get => _repo.Settings.EnableSignOffForCommit;
+            set => _repo.Settings.EnableSignOffForCommit = value;
+        }
+
         public bool EnableAutoFetch
         {
             get => _repo.Settings.EnableAutoFetch;
diff --git a/src/ViewModels/Reword.cs b/src/ViewModels/Reword.cs
@@ -39,7 +39,7 @@ public override Task<bool> Sure()
 
             return Task.Run(() =>
             {
-                var succ = new Commands.Commit(_repo.FullPath, _message, true).Exec();
+                var succ = new Commands.Commit(_repo.FullPath, _message, true, _repo.Settings.EnableSignOffForCommit).Run();
                 CallUIThread(() => _repo.SetWatcherEnabled(true));
                 return succ;
             });
diff --git a/src/ViewModels/Squash.cs b/src/ViewModels/Squash.cs
@@ -35,7 +35,7 @@ public override Task<bool> Sure()
             {
                 var succ = new Commands.Reset(_repo.FullPath, Target.SHA, "--soft").Exec();
                 if (succ)
-                    succ = new Commands.Commit(_repo.FullPath, _message, true).Exec();
+                    succ = new Commands.Commit(_repo.FullPath, _message, true, _repo.Settings.EnableSignOffForCommit).Run();
                 CallUIThread(() => _repo.SetWatcherEnabled(true));
                 return succ;
             });
diff --git a/src/ViewModels/WorkingCopy.cs b/src/ViewModels/WorkingCopy.cs
@@ -1311,7 +1311,7 @@ private void DoCommit(bool autoStage, bool autoPush, bool allowEmpty)
                     succ = new Commands.Add(_repo.FullPath, _repo.IncludeUntracked).Exec();
 
                 if (succ)
-                    succ = new Commands.Commit(_repo.FullPath, _commitMessage, _useAmend).Exec();
+                    succ = new Commands.Commit(_repo.FullPath, _commitMessage, _useAmend, _repo.Settings.EnableSignOffForCommit).Run();
 
                 Dispatcher.UIThread.Post(() =>
                 {
diff --git a/src/Views/RepositoryConfigure.axaml b/src/Views/RepositoryConfigure.axaml
@@ -51,7 +51,7 @@
           <TextBlock Classes="tab_header" Text="{DynamicResource Text.Configure.Git}"/>
         </TabItem.Header>
 
-        <Grid Margin="16,4,16,8" RowDefinitions="32,32,32,32,32,32,32,32" ColumnDefinitions="Auto,*">
+        <Grid Margin="16,4,16,8" RowDefinitions="32,32,32,32,32,32,32,32,32" ColumnDefinitions="Auto,*">
           <TextBlock Grid.Row="0" Grid.Column="0"
                      HorizontalAlignment="Right" VerticalAlignment="Center"
                      Margin="0,0,8,0"
@@ -123,10 +123,14 @@
                     IsChecked="{Binding GPGCommitSigningEnabled, Mode=TwoWay}"/>
 
           <CheckBox Grid.Row="6" Grid.Column="1"
+                    Content="{DynamicResource Text.Configure.Git.EnableSignOff}"
+                    IsChecked="{Binding EnableSignOffForCommit, Mode=TwoWay}"/>
+
+          <CheckBox Grid.Row="7" Grid.Column="1"
                     Content="{DynamicResource Text.Preference.GPG.TagEnabled}"
                     IsChecked="{Binding GPGTagSigningEnabled, Mode=TwoWay}"/>
 
-          <StackPanel Grid.Row="7" Grid.Column="1" Orientation="Horizontal">
+          <StackPanel Grid.Row="8" Grid.Column="1" Orientation="Horizontal">
             <CheckBox x:Name="AutoFetchCheckBox"
                       Content="{DynamicResource Text.Configure.Git.AutoFetch}"
                       IsChecked="{Binding EnableAutoFetch, Mode=TwoWay}"/>

Original file line number	Diff line number	Diff line change
`@@ -60,6 +60,12 @@ public string HttpProxy`
`60`	`60`	`set => SetProperty(ref _httpProxy, value);`
`61`	`61`	`}`
`62`	`62`
	`63`	`+ public bool EnableSignOffForCommit`
	`64`	`+ {`
	`65`	`+ get => _repo.Settings.EnableSignOffForCommit;`
	`66`	`+ set => _repo.Settings.EnableSignOffForCommit = value;`
	`67`	`+ }`
	`68`	`+`
`63`	`69`	`public bool EnableAutoFetch`
`64`	`70`	`{`
`65`	`71`	`get => _repo.Settings.EnableAutoFetch;`
Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@ public override Task<bool> Sure()`
`39`	`39`
`40`	`40`	`return Task.Run(() =>`
`41`	`41`	`{`
`42`		`- var succ = new Commands.Commit(_repo.FullPath, _message, true).Exec();`
	`42`	`+ var succ = new Commands.Commit(_repo.FullPath, _message, true, _repo.Settings.EnableSignOffForCommit).Run();`
`43`	`43`	`CallUIThread(() => _repo.SetWatcherEnabled(true));`
`44`	`44`	`return succ;`
`45`	`45`	`});`
Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ public override Task<bool> Sure()`
`35`	`35`	`{`
`36`	`36`	`var succ = new Commands.Reset(_repo.FullPath, Target.SHA, "--soft").Exec();`
`37`	`37`	`if (succ)`
`38`		`- succ = new Commands.Commit(_repo.FullPath, _message, true).Exec();`
	`38`	`+ succ = new Commands.Commit(_repo.FullPath, _message, true, _repo.Settings.EnableSignOffForCommit).Run();`
`39`	`39`	`CallUIThread(() => _repo.SetWatcherEnabled(true));`
`40`	`40`	`return succ;`
`41`	`41`	`});`
Original file line number	Diff line number	Diff line change
`@@ -1311,7 +1311,7 @@ private void DoCommit(bool autoStage, bool autoPush, bool allowEmpty)`
`1311`	`1311`	`succ = new Commands.Add(_repo.FullPath, _repo.IncludeUntracked).Exec();`
`1312`	`1312`
`1313`	`1313`	`if (succ)`
`1314`		`- succ = new Commands.Commit(_repo.FullPath, _commitMessage, _useAmend).Exec();`
	`1314`	`+ succ = new Commands.Commit(_repo.FullPath, _commitMessage, _useAmend, _repo.Settings.EnableSignOffForCommit).Run();`
`1315`	`1315`
`1316`	`1316`	`Dispatcher.UIThread.Post(() =>`
`1317`	`1317`	`{`