chore: Improve logging by moving git operations progress to DEBUG level (#40)

Author: jphuynh

README.md

@@ -151,7 +151,7 @@ COMMAND SUPPLIED
       git-xargs --version
       ```
 
-### Installion option 2: Run go get
+### Installation option 2: Run go get
 
 1. Ensure you have Golang installed and working properly on your system. [Follow the official Golang install guide](https://golang.org/doc/install) to get started.
 
@@ -333,14 +333,14 @@ echo "gruntwork-io/terragrunt gruntwork-io/terratest" | git-xargs \
 | `--commit-message`       | The commit message to use when creating commits. If you supply this flag, but neither the optional `--pull-request-title` or `--pull-request-description` flags, then the commit message value will be used for all three.                                                                                                                                                                                                     | String  | No       |
 | `--skip-pull-requests`   | If you don't want any pull requests opened, but would rather have your changes committed directly to your specified branch, pass this flag. Note that it won't work if your Github repo is configured with branch protections on the branch you're trying to commit directly to!                                                                                                                                               | Boolean | No       |
 | `--skip-archived-repos`  | If you want to exclude archived (read-only) repositories from the list of targeted repos, pass this flag.                                                                                                                                                                                                                                                                                                                      | Boolean | No       |
-| `--dry-run`              | If you are in the process of testing out `git-xargs` or your intial set of targeted repos, but you don't want to make any changes via the Github API (pushing your local changes or opening pull requests) you can pass the dry-run branch. This is useful because the output report will still tell you which repos would have been affected, without actually making changes via the Github API to your remote repositories. | Boolean | No       |
+| `--dry-run`              | If you are in the process of testing out `git-xargs` or your initial set of targeted repos, but you don't want to make any changes via the Github API (pushing your local changes or opening pull requests) you can pass the dry-run branch. This is useful because the output report will still tell you which repos would have been affected, without actually making changes via the Github API to your remote repositories. | Boolean | No       |
 | `--max-concurrent-repos` | Limits the number of concurrent processed repositories. This is only useful if you encounter issues and need throttling when running on a very large number of repos.  Default is `0` (Unlimited)                                                                                                                                                                                                                              | Integer | No       |
 
 ## Best practices, tips and tricks
 
 ### Write your script to run against a single repo
 
-Write your script as if its operating on a single repo, then target many repos with `git-xargs`. Remember that at runtime, each of the scripts you select will be run, in the order you specify, once per repo that you've targeted.
+Write your script as if it's operating on a single repo, then target many repos with `git-xargs`. Remember that at runtime, each of the scripts you select will be run, in the order you specify, once per repo that you've targeted.
 
 ### Handling prerequisites and third party binaries
 
@@ -360,7 +360,7 @@ This section provides a more in-depth look at how the `git-xargs` tool works und
 1. it will run all your selected scripts against your selected repos
 1. it will commit any changes in each of the repos (with a commit message you can optionally specify via the `--commit-message` flag)
 1. it will push your local branch with your new commits to your repo's remote
-1. it will call the Github API to open a pull request with a title and description that you can optionally specify via the `--pull-request-title` and `--pull-request-description` flags, respectively), unless you pass the `--skip-pull-requests` flag
+1. it will call the Github API to open a pull request with a title and description that you can optionally specify via the `--pull-request-title` and `--pull-request-description` flags, respectively, unless you pass the `--skip-pull-requests` flag
 1. it will print out a detailed run summary to STDOUT that explains exactly what happened with each repo and provide links to successfully opened pull requests that you can quickly follow from your terminal. If any repos encountered errors at runtime (whether they weren't able to be cloned, or script errors were encountered during processing, etc) all of this will be spelled out in detail in the final report so you know exactly what succeeded and what went wrong.
 
 ## Tasks this tool is well-suited for
@@ -374,7 +374,7 @@ The following is a non-exhaustive list of potential use cases for `git-xargs`:
 - Add new files to repos
 - Delete specific files, when present, from repos
 - Modify `package.json` files in-place across repos to bump a node.js dependency using `jq` https://stedolan.github.io/jq/
-- Update your Terraform module library from Terraform 0.13 to 0.14 .
+- Update your Terraform module library from Terraform 0.13 to 0.14.
 - Remove stray files of any kind, when found, across repos using `find` and its `exec` option
 - Add baseline tests to repos that are missing them by copying over a common local folder where they are defined
 - Refactor multiple Golang tools to use new libraries by executing `go get` to install and uninstall packages, and modify the source code files' import references

repository/process.go

@@ -47,6 +47,8 @@ func ProcessRepos(gitxargsConfig *config.GitXargsConfig, repos []*github.Reposit
 // 8. Track all successfully opened pull requests via the stats tracker so that we can print them out as part of our final
 // run report that is displayed in table format to the operator following each run
 func processRepo(config *config.GitXargsConfig, repo *github.Repository) error {
+	logger := logging.GetLogger("git-xargs")
+	
 	// Create a new temporary directory in the default temp directory of the system, but append
 	// 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)
@@ -86,5 +88,9 @@ func processRepo(config *config.GitXargsConfig, repo *github.Repository) error {
 		return err
 	}
 
+	logger.WithFields(logrus.Fields{
+		"Repo name": repo.GetName(),
+	}).Info("Repository successfully processed")
+
 	return nil
 }

repository/repo-operations.go

@@ -1,6 +1,7 @@
 package repository
 
 import (
+	"bytes"
 	"context"
 	"fmt"
 	"io/ioutil"
@@ -41,15 +42,20 @@ func cloneLocalRepository(config *config.GitXargsConfig, repo *github.Repository
 		return repositoryDir, nil, errors.WithStackTrace(tmpDirErr)
 	}
 
+	gitProgressBuffer := bytes.NewBuffer(nil)
 	localRepository, err := config.GitClient.PlainClone(repositoryDir, false, &git.CloneOptions{
 		URL:      repo.GetCloneURL(),
-		Progress: os.Stdout,
+		Progress: gitProgressBuffer,
 		Auth: &http.BasicAuth{
 			Username: repo.GetOwner().GetLogin(),
 			Password: os.Getenv("GITHUB_OAUTH_TOKEN"),
 		},
 	})
 
+	logger.WithFields(logrus.Fields{
+		"Repo":  repo.GetName(),
+	}).Debug(gitProgressBuffer)
+
 	if err != nil {
 		logger.WithFields(logrus.Fields{
 			"Error": err,
@@ -178,16 +184,21 @@ func checkoutLocalBranch(config *config.GitXargsConfig, ref *plumbing.Reference,
 	}
 
 	// Pull latest code from remote branch if it exists to avoid fast-forwarding errors
+	gitProgressBuffer := bytes.NewBuffer(nil)
 	po := &git.PullOptions{
 		RemoteName:    "origin",
 		ReferenceName: branchName,
 		Auth: &http.BasicAuth{
 			Username: remoteRepository.GetOwner().GetLogin(),
 			Password: os.Getenv("GITHUB_OAUTH_TOKEN"),
 		},
-		Progress: os.Stdout,
+		Progress: gitProgressBuffer,
 	}
 
+	logger.WithFields(logrus.Fields{
+		"Repo":  remoteRepository.GetName(),
+	}).Debug(gitProgressBuffer)
+
 	pullErr := worktree.Pull(po)
 
 	if pullErr != nil {
@@ -276,7 +287,10 @@ func commitLocalChanges(status git.Status, config *config.GitXargsConfig, reposi
 
 	for filepath := range status {
 		if status.IsUntracked(filepath) {
-			fmt.Printf("Found untracked file %s. Adding to stage", filepath)
+			logger.WithFields(logrus.Fields{
+				"Filepath": filepath,
+			}).Debug("Found untracked file. Adding to stage")
+
 			_, addErr := worktree.Add(filepath)
 			if addErr != nil {
 				logger.WithFields(logrus.Fields{