Deprecate maintainOnlyServerHooks in favor of maintainedHooks ⚓ (#76

)
gabyx · Dec 19, 2021 · 4c54578 · 4c54578
1 parent b4a05b0
commit 4c54578
Show file tree

Hide file tree

Showing 6 changed files with 17 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -1111,8 +1111,7 @@ can then attach to the debug server with the debug configuration
 
 ### Todos:
 
-- Test: `githooks.disableSharedHooksUpdate`.
-- Finish deploy settings implementation for Gitea and sorts.
+- Finish deploy settings implementation for Gitea and others.
 
 ## Changelog
 

diff --git a/githooks/cmd/installer/installer.go b/githooks/cmd/installer/installer.go
@@ -1203,6 +1203,8 @@ func runUpdate(
 
 	log.InfoF("Running install to version '%s' ...", build.BuildVersion)
 
+	transformLegacyGitConfigSettings(log, gitx)
+
 	// Read registered file if existing.
 	// We ensured during load, that only existing Git directories are listed.
 	err := settings.RegisteredGitDirs.Load(settings.InstallDir, true, true)
@@ -1369,3 +1371,13 @@ func runInstall(cmd *cobra.Command, ctx *ccm.CmdContext, vi *viper.Viper) {
 			"occurred!", logStats.ErrorCount(), logStats.WarningCount())
 	}
 }
+
+func transformLegacyGitConfigSettings(log cm.ILogContext, gitx *git.Context) {
+	useOnlyServerHooks := gitx.GetConfig("githooks.maintainOnlyServerHooks", git.GlobalScope)
+	if useOnlyServerHooks == git.GitCVTrue {
+		err := hooks.SetMaintainedHooks(gitx, []string{"server"}, git.GlobalScope)
+		log.AssertNoError(err, "Could not set maintained hooks to 'server'.")
+	}
+
+	_ = git.Ctx().UnsetConfig("githooks.maintainOnlyServerHooks", git.GlobalScope)
+}
diff --git a/githooks/cmd/uninstaller/uninstaller.go b/githooks/cmd/uninstaller/uninstaller.go
@@ -313,6 +313,9 @@ func cleanGitConfig(log cm.ILogContext, gitx *git.Context) {
 	k := "githooks.checksumCacheDir"
 	log.AssertNoErrorF(gitx.UnsetConfig(k, git.GlobalScope),
 		"Could not unset global Git config '%s'.", k)
+	k = "githooks.maintainOnlyServerHooks"
+	log.AssertNoErrorF(gitx.UnsetConfig(k, git.GlobalScope),
+		"Could not unset global Git config '%s'.", k)
 }
 
 func cleanRegister(log cm.ILogContext, installDir string) {

diff --git a/githooks/hooks/gitconfig.go b/githooks/hooks/gitconfig.go
@@ -8,8 +8,6 @@ const (
 
 	GitCKDisable = "githooks.disable"
 
-	GitCKMaintainOnlyServerHooks = "githooks.maintainOnlyServerHooks" // deprecate
-
 	GitCKAutoUpdateEnabled        = "githooks.autoUpdateEnabled"
 	GitCKAutoUpdateCheckTimestamp = "githooks.autoUpdateCheckTimestamp"
 	GitCKAutoUpdateUsePrerelease  = "githooks.autoUpdateUsePrerelease"
@@ -61,7 +59,6 @@ func GetGlobalGitConfigKeys() []string {
 
 		GitCKDisable,
 
-		GitCKMaintainOnlyServerHooks, // deprecate
 		GitCKMaintainedHooks,
 		GitCKPreviousSearchDir,
 

diff --git a/githooks/hooks/hook-names.go b/githooks/hooks/hook-names.go
@@ -109,11 +109,6 @@ func SetMaintainedHooks(
 		maintainedHooks = append(maintainedHooks, "all")
 	}
 
-	// Deprecation
-	if scope == git.GlobalScope {
-		_ = git.Ctx().UnsetConfig(GitCKMaintainOnlyServerHooks, scope)
-	}
-
 	err = git.Ctx().SetConfig(GitCKMaintainedHooks, strings.Join(maintainedHooks, ", "), scope)
 
 	if err != nil {

diff --git a/githooks/scripts/clean-install.sh b/githooks/scripts/clean-install.sh
@@ -4,7 +4,7 @@ echo "Unset all githooks configs ..."
 git config --global --unset githooks.runner
 git config --global --unset-all githooks.shared
 git config --global --unset githooks.failOnNonExistingSharedHooks
-git config --global --unset githooks.maintainOnlyServerHooks
+git config --global --unset githooks.maintainedHooks
 git config --global --unset githooks.autoUpdateEnabled
 git config --global --unset githooks.autoUpdateCheckTimestamp
 git config --global --unset githooks.cloneUrl