Support changing git config through `app.ini`, use `diff.algorithm=histogram` by default (#24860)

+22 -26

custom/conf/app.example.ini

··· 683 683 ;DISABLE_PARTIAL_CLONE = false 684 684 685 685 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; 686 + ;; Git Operation timeout in seconds 687 + ;[git.timeout] 688 + ;DEFAULT = 360 689 + ;MIGRATE = 600 690 + ;MIRROR = 300 691 + ;CLONE = 300 692 + ;PULL = 300 693 + ;GC = 60 694 + 695 + ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; 696 + ;; Git Reflog timeout in days 697 + ;[git.reflog] 698 + ;ENABLED = true 699 + ;EXPIRATION = 90 700 + 701 + ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; 702 + ;; Git config options 703 + ;; This section only does "set" config, a removed config key from this section won't be removed from git config automatically. The format is `some.configKey = value`. 704 + ;[git.config] 705 + ;diff.algorithm = histogram 706 + 707 + ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; 686 708 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; 687 709 [service] 688 710 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ··· 2175 2197 ;NUMBER_TO_CHECK_PER_REPO = 100 2176 2198 ;Check at least this proportion of LFSMetaObjects per repo. (This may cause all stale LFSMetaObjects to be checked.) 2177 2199 ;PROPORTION_TO_CHECK_PER_REPO = 0.6 2178 - 2179 - 2180 - ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; 2181 - ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; 2182 - ;; Git Operation timeout in seconds 2183 - ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; 2184 - ;[git.timeout] 2185 - ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; 2186 - ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; 2187 - ;DEFAULT = 360 2188 - ;MIGRATE = 600 2189 - ;MIRROR = 300 2190 - ;CLONE = 300 2191 - ;PULL = 300 2192 - ;GC = 60 2193 - 2194 - 2195 - ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; 2196 - ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; 2197 - ;; Git Reflog timeout in days 2198 - ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; 2199 - ;[git.reflog] 2200 - ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; 2201 - ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; 2202 - ;ENABLED = true 2203 - ;EXPIRATION = 90 2204 2200 2205 2201 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; 2206 2202 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;

+13 -6

docs/content/doc/administration/config-cheat-sheet.en-us.md

··· 1054 1054 - `DISABLE_CORE_PROTECT_NTFS`: **false** Set to true to forcibly set `core.protectNTFS` to false. 1055 1055 - `DISABLE_PARTIAL_CLONE`: **false** Disable the usage of using partial clones for git. 1056 1056 1057 - ## Git - Reflog settings (`git.reflog`) 1058 - 1059 - - `ENABLED`: **true** Set to true to enable Git to write changes to reflogs in each repo. 1060 - - `EXPIRATION`: **90** Reflog entry lifetime, in days. Entries are removed opportunistically by Git. 1061 - 1062 - ## Git - Timeout settings (`git.timeout`) 1057 + ### Git - Timeout settings (`git.timeout`) 1063 1058 1064 1059 - `DEFAULT`: **360**: Git operations default timeout seconds. 1065 1060 - `MIGRATE`: **600**: Migrate external repositories timeout seconds. ··· 1067 1062 - `CLONE`: **300**: Git clone from internal repositories timeout seconds. 1068 1063 - `PULL`: **300**: Git pull from internal repositories timeout seconds. 1069 1064 - `GC`: **60**: Git repository GC timeout seconds. 1065 + 1066 + ### Git - Reflog settings (`git.reflog`) 1067 + 1068 + - `ENABLED`: **true** Set to true to enable Git to write changes to reflogs in each repo. 1069 + - `EXPIRATION`: **90** Reflog entry lifetime, in days. Entries are removed opportunistically by Git. 1070 + 1071 + ### Git - Config options (`git.config`) 1072 + 1073 + The key/value pairs in this section will be used as git config. 1074 + This section only does "set" config, a removed config key from this section won't be removed from git config automatically. The format is `some.configKey = value`. 1075 + 1076 + - `diff.algorithm`: **histogram** 1070 1077 1071 1078 ## Metrics (`metrics`) 1072 1079

+16

docs/content/doc/administration/customizing-gitea.en-us.md

··· 282 282 283 283 To add custom .gitignore, add a file with existing [.gitignore rules](https://git-scm.com/docs/gitignore) in it to `$GITEA_CUSTOM/options/gitignore` 284 284 285 + ## Customizing the git configuration 286 + 287 + Starting with Gitea 1.20, you can customize the git configuration via the `git.config` section. 288 + 289 + ### Enabling signed git pushes 290 + 291 + To enable signed git pushes, set these two options: 292 + 293 + ```ini 294 + [git.config] 295 + receive.advertisePushOptions = true 296 + receive.certNonceSeed = <randomstring> 297 + ``` 298 + 299 + `certNonceSeed` should be set to a random string and be kept secret. 300 + 285 301 ### Labels 286 302 287 303 Starting with Gitea 1.19, you can add a file that follows the [YAML label format](https://github.com/go-gitea/gitea/blob/main/options/label/Advanced.yaml) to `$GITEA_CUSTOM/options/label`:

+8

modules/git/git.go

··· 224 224 return fmt.Errorf("unable to prepare git home directory %s, err: %w", HomeDir(), err) 225 225 } 226 226 227 + // first, write user's git config options to git config file 228 + // user config options could be overwritten by builtin values later, because if a value is builtin, it must have some special purposes 229 + for k, v := range setting.GitConfig.Options { 230 + if err = configSet(strings.ToLower(k), v); err != nil { 231 + return err 232 + } 233 + } 234 + 227 235 // Git requires setting user.name and user.email in order to commit changes - old comment: "if they're not set just add some defaults" 228 236 // TODO: need to confirm whether users really need to change these values manually. It seems that these values are dummy only and not really used. 229 237 // If these values are not really used, then they can be set (overwritten) directly without considering about existence.

+18 -6

modules/git/git_test.go

··· 42 42 } 43 43 } 44 44 45 - func TestGitConfig(t *testing.T) { 46 - gitConfigContains := func(sub string) bool { 47 - if b, err := os.ReadFile(HomeDir() + "/.gitconfig"); err == nil { 48 - return strings.Contains(string(b), sub) 49 - } 50 - return false 45 + func gitConfigContains(sub string) bool { 46 + if b, err := os.ReadFile(HomeDir() + "/.gitconfig"); err == nil { 47 + return strings.Contains(string(b), sub) 51 48 } 49 + return false 50 + } 52 51 52 + func TestGitConfig(t *testing.T) { 53 53 assert.False(t, gitConfigContains("key-a")) 54 54 55 55 assert.NoError(t, configSetNonExist("test.key-a", "val-a")) ··· 81 81 assert.NoError(t, configUnsetAll("test.key-x", "*")) 82 82 assert.False(t, gitConfigContains("key-x = *")) 83 83 } 84 + 85 + func TestSyncConfig(t *testing.T) { 86 + oldGitConfig := setting.GitConfig 87 + defer func() { 88 + setting.GitConfig = oldGitConfig 89 + }() 90 + 91 + setting.GitConfig.Options["sync-test.cfg-key-a"] = "CfgValA" 92 + assert.NoError(t, syncGitConfig()) 93 + assert.True(t, gitConfigContains("[sync-test]")) 94 + assert.True(t, gitConfigContains("cfg-key-a = CfgValA")) 95 + }

+17

modules/setting/git.go

··· 5 5 6 6 import ( 7 7 "path/filepath" 8 + "strings" 8 9 "time" 9 10 10 11 "code.gitea.io/gitea/modules/log" ··· 78 79 }, 79 80 } 80 81 82 + var GitConfig = struct { 83 + Options map[string]string 84 + }{ 85 + Options: make(map[string]string), 86 + } 87 + 81 88 func loadGitFrom(rootCfg ConfigProvider) { 82 89 sec := rootCfg.Section("git") 83 90 if err := sec.MapTo(&Git); err != nil { 84 91 log.Fatal("Failed to map Git settings: %v", err) 92 + } 93 + 94 + secGitConfig := rootCfg.Section("git.config") 95 + GitConfig.Options = make(map[string]string) 96 + for _, key := range secGitConfig.Keys() { 97 + // git config key is case-insensitive, so always use lower-case 98 + GitConfig.Options[strings.ToLower(key.Name())] = key.String() 99 + } 100 + if _, ok := GitConfig.Options["diff.algorithm"]; !ok { 101 + GitConfig.Options["diff.algorithm"] = "histogram" 85 102 } 86 103 87 104 Git.HomePath = sec.Key("HOME_PATH").MustString("home")

+40

modules/setting/git_test.go

··· 1 + // Copyright 2019 The Gitea Authors. All rights reserved. 2 + // SPDX-License-Identifier: MIT 3 + 4 + package setting 5 + 6 + import ( 7 + "testing" 8 + 9 + "github.com/stretchr/testify/assert" 10 + ) 11 + 12 + func TestGitConfig(t *testing.T) { 13 + oldGit := Git 14 + oldGitConfig := GitConfig 15 + defer func() { 16 + Git = oldGit 17 + GitConfig = oldGitConfig 18 + }() 19 + 20 + cfg, err := NewConfigProviderFromData(` 21 + [git.config] 22 + a.b = 1 23 + `) 24 + assert.NoError(t, err) 25 + loadGitFrom(cfg) 26 + 27 + assert.Len(t, GitConfig.Options, 2) 28 + assert.EqualValues(t, "1", GitConfig.Options["a.b"]) 29 + assert.EqualValues(t, "histogram", GitConfig.Options["diff.algorithm"]) 30 + 31 + cfg, err = NewConfigProviderFromData(` 32 + [git.config] 33 + diff.algorithm = other 34 + `) 35 + assert.NoError(t, err) 36 + loadGitFrom(cfg) 37 + 38 + assert.Len(t, GitConfig.Options, 1) 39 + assert.EqualValues(t, "other", GitConfig.Options["diff.algorithm"]) 40 + }

Configure Feed

Configure Feed