Clean up temporary clone paths by default (#113)

- Add flag (--keep-cloned-repositories) to preserve them

Author: zackproser

README.md

@@ -426,6 +426,7 @@ echo "gruntwork-io/terragrunt gruntwork-io/terratest" | git-xargs \
 | `--no-skip-ci` | By default, git-xargs will prepend \"[skip ci]\" to its commit messages to prevent large git-xargs jobs from creating expensive CI jobs excessively. If you pass the `--no-skip-ci` flag, then git-xargs will not prepend \"[skip ci]\". Default: false, meaning that \"[skip ci]\" will be prepended to commit messages.                                                                                                                                                                | Bool | No       |
 | `--reviewers` | An optional slice of GitHub usernames, separated by commas, to request reviews from after a pull request is successfully opened. Default: empty slice, meaning that no reviewers will be requested.                                                                                                                                                                | String | No       |
 | `--team-reviewers` | An optional slice of GitHub team names, separated by commas, to request reviews from after a pull request is successfully opened. Default: empty slice, meaning that no team reviewers will be requested. IMPORTANT: Please read and understand [the GitHub restrictions](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review) on this functionality before using it! Only certain GitHub organizations / payment plans support this functionality.                                                                                                                                                                 | String | No       | 
+| `--keep-cloned-repositories` | By default, git-xargs will delete the repositories it clones to your temporary file directory once it has completed processing that repo, to save space on your machine. If you wish to retain the local repositories, pass this flag.  | Bool | No |
 ## Best practices, tips and tricks
 
 ### Write your script to run against a single repo

cmd/git-xargs.go

@@ -42,6 +42,7 @@ func parseGitXargsConfig(c *cli.Context) (*config.GitXargsConfig, error) {
 	config.PullRequestRetries = c.Int("max-pr-retries")
 	config.SecondsToSleepWhenRateLimited = c.Int("seconds-to-wait-when-rate-limited")
 	config.NoSkipCI = c.Bool("no-skip-ci")
+	config.RetainLocalRepos = c.Bool("keep-cloned-repositories")
 	// By default, prepend "[skip ci]" to commit messages, unless the user passed --no-skip-ci
 	if config.NoSkipCI == false {
 		commitMsgWithCISkip := fmt.Sprintf("%s %s", "[skip ci]", config.CommitMessage)

common/common.go

@@ -24,6 +24,7 @@ const (
 	MaxPullRequestRetriesFlagName        = "max-pr-retries"
 	SecondsToWaitWhenRateLimitedFlagName = "seconds-to-wait-when-rate-limited"
 	NoSkipCIFlagName                     = "no-skip-ci"
+	KeepClonedRepositoriesFlagName       = "keep-cloned-repositories"
 	DefaultMaxConcurrentRepos            = 0
 	DefaultSecondsBetweenPRs             = 1
 	DefaultMaxPullRequestRetries         = 3
@@ -109,4 +110,8 @@ var (
 		Name:  NoSkipCIFlagName,
 		Usage: "By default, git-xargs prepends \"[skip ci]\" to its commit messages. Pass this flag to prevent \"[skip ci]\" from being prepending to commit messages.",
 	}
+	GenericKeepClonedRepositoriesFlag = cli.BoolFlag{
+		Name:  KeepClonedRepositoriesFlagName,
+		Usage: "By default, git-xargs deletes the cloned repositories from the temp directory after the command has finished running, to save space on your machine. Pass this flag to prevent git-xargs from deleting the cloned repositories.",
+	}
 )

config/config.go

@@ -39,6 +39,7 @@ type GitXargsConfig struct {
 	PullRequestRetries            int
 	SecondsToSleepWhenRateLimited int
 	NoSkipCI                      bool
+	RetainLocalRepos              bool
 	Ticker                        *time.Ticker
 }
 
@@ -70,6 +71,7 @@ func NewGitXargsConfig() *GitXargsConfig {
 		SecondsToSleepWhenRateLimited: common.DefaultSecondsToWaitWhenRateLimited,
 		PullRequestRetries:            common.DefaultMaxPullRequestRetries,
 		NoSkipCI:                      false,
+		RetainLocalRepos:              false,
 	}
 }
 

main.go

@@ -77,6 +77,7 @@ func setupApp() *cli.App {
 		common.GenericMaxPullRequestRetriesFlag,
 		common.GenericSecondsToWaitWhenRateLimitedFlag,
 		common.GenericNoSkipCIFlag,
+		common.GenericKeepClonedRepositoriesFlag,
 	}
 
 	app.Action = cmd.RunGitXargs

repository/process.go

@@ -1,6 +1,7 @@
 package repository
 
 import (
+	"os"
 	"sync"
 	"time"
 
@@ -70,6 +71,19 @@ func ProcessRepos(gitxargsConfig *config.GitXargsConfig, repos []*github.Reposit
 	return nil
 }
 
+// cleanupTempDir removes the temporary directory that was created for the local clone of the repo
+// It logs a debug-level error if the directory could not be removed, but does not return an error
+func cleanupTempDir(repositoryDir string) {
+	logger := logging.GetLogger("git-xargs")
+	removeErr := os.RemoveAll(repositoryDir)
+	if removeErr != nil {
+		logger.WithFields(logrus.Fields{
+			"Error":          removeErr,
+			"Temp directory": repositoryDir,
+		}).Debug("Error encountered while removing temporary directory")
+	}
+}
+
 // 1. Attempt to clone it to the local filesystem. To avoid conflicts, this generates a new directory for each repo FOR EACH run, so heavy use of this tool may inflate your /tmp/ directory size
 // 2. Look up the HEAD ref of the repo, and create a new branch from that ref, specific to this tool so that we can safely make our changes in the branch
 // 3. Execute the supplied command against the locally cloned repo
@@ -86,6 +100,11 @@ func processRepo(config *config.GitXargsConfig, repo *github.Repository) error {
 	// git-xargs-<repo-name> to it so that it's easier to find when you're looking for it
 	repositoryDir, localRepository, cloneErr := cloneLocalRepository(config, repo)
 
+	// if user did not pass retention flag, defer cleanup of the repositoryDir
+	if config.RetainLocalRepos == false {
+		defer cleanupTempDir(repositoryDir)
+	}
+
 	if cloneErr != nil {
 		return cloneErr
 	}