feat: Add --draft flag for draft pull requests (#49)

Author: ryanwholey

README.md

@@ -319,7 +319,7 @@ Oftentimes, you want finer-grained control over the exact repos you are going to
 
 ```
 git-xargs \
-  --commit-mesage "Update copyright year" \
+  --commit-message "Update copyright year" \
   --repos data/batch2.txt \
   "$(pwd)/scripts/update-copyright-year.sh"
 ```
@@ -343,7 +343,7 @@ arguments:
 
 ```
 git-xargs \
-  --commit-mesage "Update copyright year" \
+  --commit-message "Update copyright year" \
   --repo gruntwork-io/terragrunt \
   --repo gruntwork-io/terratest \
   --repo gruntwork-io/cloud-nuke \
@@ -357,7 +357,7 @@ use by piping them in via `stdin`, separating repo names with whitespace or newl
 
 ```
 echo "gruntwork-io/terragrunt gruntwork-io/terratest" | git-xargs \
-  --commit-mesage "Update copyright year" \
+  --commit-message "Update copyright year" \
   "$(pwd)/scripts/update-copyright-year.sh"
 ```
 
@@ -377,6 +377,8 @@ echo "gruntwork-io/terragrunt gruntwork-io/terratest" | git-xargs \
 | `--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 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 flag. 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       |
+| `--draft` | Whether to open pull requests in draft mode. Draft pull requests are available for public GitHub repositories and private repositories in GitHub tiered accounts. See [Draft Pull Requests](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests#draft-pull-requests) for more details.  | Boolean | No |
+
 
 ## Best practices, tips and tricks
 

cmd/git-xargs.go

@@ -20,6 +20,7 @@ import (
 // to an internal representation of the data supplied by the user
 func parseGitXargsConfig(c *cli.Context) (*config.GitXargsConfig, error) {
 	config := config.NewGitXargsConfig()
+	config.Draft = c.Bool("draft")
 	config.DryRun = c.Bool("dry-run")
 	config.SkipPullRequests = c.Bool("skip-pull-requests")
 	config.SkipArchivedRepos = c.Bool("skip-archived-repos")

common/common.go

@@ -4,6 +4,7 @@ import "github.com/urfave/cli"
 
 const (
 	GithubOrgFlagName              = "github-org"
+	DraftPullRequestFlagName       = "draft"
 	DryRunFlagName                 = "dry-run"
 	SkipPullRequestsFlagName       = "skip-pull-requests"
 	SkipArchivedReposFlagName      = "skip-archived-repos"
@@ -25,6 +26,10 @@ var (
 		Name:  GithubOrgFlagName,
 		Usage: "The Github organization to fetch all repositories from.",
 	}
+	GenericDraftPullRequestFlag = cli.BoolFlag{
+		Name:  DraftPullRequestFlagName,
+		Usage: "Whether to open pull requests in draft mode",
+	}
 	GenericDryRunFlag = cli.BoolFlag{
 		Name:  DryRunFlagName,
 		Usage: "When dry-run is set to true, no local branch changes will pushed and no pull requests will be opened.",

config/config.go

@@ -12,6 +12,7 @@ import (
 
 // GitXargsConfig is the internal representation of a given git-xargs run as specified by the user
 type GitXargsConfig struct {
+	Draft                  bool
 	DryRun                 bool
 	SkipPullRequests       bool
 	SkipArchivedRepos      bool
@@ -33,6 +34,7 @@ type GitXargsConfig struct {
 // NewGitXargsConfig sets reasonable defaults for a GitXargsConfig and returns a pointer to the config
 func NewGitXargsConfig() *GitXargsConfig {
 	return &GitXargsConfig{
+		Draft:                  false,
 		DryRun:                 false,
 		SkipPullRequests:       false,
 		SkipArchivedRepos:      false,

main.go

@@ -62,6 +62,7 @@ func setupApp() *cli.App {
 	app.Flags = []cli.Flag{
 		LogLevelFlag,
 		common.GenericGithubOrgFlag,
+		common.GenericDraftPullRequestFlag,
 		common.GenericDryRunFlag,
 		common.GenericSkipPullRequestFlag,
 		common.GenericSkipArchivedReposFlag,

printer/printer.go

@@ -82,6 +82,16 @@ func PrintRepoReport(allEvents []types.AnnotatedEvent, runReport *types.RunRepor
 		pullRequests = append(pullRequests, pr)
 	}
 
+	var draftPullRequests []types.PullRequest
+
+	for repoName, prURL := range runReport.DraftPullRequests {
+		pr := types.PullRequest{
+			Repo: repoName,
+			URL:  prURL,
+		}
+		draftPullRequests = append(draftPullRequests, pr)
+	}
+
 	if len(pullRequests) > 0 {
 		fmt.Println()
 		fmt.Println("*****************************************************")
@@ -93,4 +103,16 @@ func PrintRepoReport(allEvents []types.AnnotatedEvent, runReport *types.RunRepor
 		fmt.Println()
 
 	}
+
+	if len(draftPullRequests) > 0 {
+		fmt.Println()
+		fmt.Println("*****************************************************")
+		fmt.Println("  DRAFT PULL REQUESTS OPENED")
+		fmt.Println("*****************************************************")
+		pullRequestPrinter := tableprinter.New(os.Stdout)
+		configurePrinterStyling(pullRequestPrinter)
+		pullRequestPrinter.Print(draftPullRequests)
+		fmt.Println()
+
+	}
 }

repository/repo-operations.go

@@ -442,30 +442,48 @@ func openPullRequest(config *config.GitXargsConfig, repo *github.Repository, bra
 		Base:                github.String(repoDefaultBranch),
 		Body:                github.String(descriptionToUse),
 		MaintainerCanModify: github.Bool(true),
+		Draft:               github.Bool(config.Draft),
 	}
 
-	// Make a pull request via the GitHub API
-	pr, _, err := config.GithubClient.PullRequests.Create(context.Background(), *repo.GetOwner().Login, repo.GetName(), newPR)
+	// Make a pull request via the Github API
+	pr, resp, err := config.GithubClient.PullRequests.Create(context.Background(), *repo.GetOwner().Login, repo.GetName(), newPR)
+
+	prErrorMessage := "Error opening pull request"
+	prDraftModeNotSupported := false
 
 	if err != nil {
+		if resp.StatusCode == 422 {
+			// Update the error to be more RepoDoesntSupportDraftPullRequestsErra Draft PR
+			prErrorMessage = "Error opening pull request: draft PRs not supported for this repo. See https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests#draft-pull-requests"
+			prDraftModeNotSupported = true
+		}
+
 		logger.WithFields(logrus.Fields{
 			"Error": err,
 			"Head":  branch,
 			"Base":  repoDefaultBranch,
 			"Body":  descriptionToUse,
-		}).Debug("Error opening Pull request")
+		}).Debug(prErrorMessage)
 
 		// Track pull request open failure
-		config.Stats.TrackSingle(stats.PullRequestOpenErr, repo)
+		if prDraftModeNotSupported {
+			config.Stats.TrackSingle(stats.RepoDoesntSupportDraftPullRequestsErr, repo)
+		} else {
+			config.Stats.TrackSingle(stats.PullRequestOpenErr, repo)
+		}
 		return errors.WithStackTrace(err)
 	}
 
 	logger.WithFields(logrus.Fields{
 		"Pull Request URL": pr.GetHTMLURL(),
 	}).Debug("Successfully opened pull request")
 
-	// Track successful opening of the pull request, extracting the HTML url to the PR itself for easier review
-	config.Stats.TrackPullRequest(repo.GetName(), pr.GetHTMLURL())
+	if config.Draft {
+		config.Stats.TrackDraftPullRequest(repo.GetName(), pr.GetHTMLURL())
+	} else {
+		// Track successful opening of the pull request, extracting the HTML url to the PR itself for easier review
+		config.Stats.TrackPullRequest(repo.GetName(), pr.GetHTMLURL())
+	}
 	return nil
 }
 

stats/stats.go

@@ -68,6 +68,8 @@ const (
 	BranchRemoteDidntExistYet types.Event = "branch-remote-didnt-exist-yet"
 	// RepoFlagSuppliedRepoMalformed denotes a repo passed via the --repo flag that was malformed (perhaps missing it's Github org prefix) and therefore unprocessable
 	RepoFlagSuppliedRepoMalformed types.Event = "repo-flag-supplied-repo-malformed"
+	// RepoDoesntSupportDraftPullRequestsErr denotes a repo that is incompatible with the submitted pull request configuration
+	RepoDoesntSupportDraftPullRequestsErr types.Event = "repo-not-compatible-with-pull-config"
 )
 
 var allEvents = []types.AnnotatedEvent{
@@ -97,6 +99,7 @@ var allEvents = []types.AnnotatedEvent{
 	{Event: BranchRemotePullFailed, Description: "Repos whose remote branches could not be successfully pulled"},
 	{Event: BranchRemoteDidntExistYet, Description: "Repos whose specified branches did not exist on the remote, and so were first created locally"},
 	{Event: RepoFlagSuppliedRepoMalformed, Description: "Repos passed via the --repo flag that were malformed (missing their Github org prefix?) and therefore unprocessable"},
+	{Event: RepoDoesntSupportDraftPullRequestsErr, Description: "Repos that do not support Draft PRs (--draft flag was passed)"},
 }
 
 // RunStats will be a stats-tracker class that keeps score of which repos were touched, which were considered for update, which had branches made, PRs made, which were missing workflows or contexts, or had out of date workflows syntax values, etc
@@ -105,6 +108,7 @@ type RunStats struct {
 	repos                 map[types.Event][]*github.Repository
 	skippedArchivedRepos  map[types.Event][]*github.Repository
 	pulls                 map[string]string
+	draftpulls            map[string]string
 	command               []string
 	fileProvidedRepos     []*types.AllowedRepo
 	repoFlagProvidedRepos []*types.AllowedRepo
@@ -122,6 +126,7 @@ func NewStatsTracker() *RunStats {
 		repos:                 make(map[types.Event][]*github.Repository),
 		skippedArchivedRepos:  make(map[types.Event][]*github.Repository),
 		pulls:                 make(map[string]string),
+		draftpulls:            make(map[string]string),
 		command:               []string{},
 		fileProvidedRepos:     fileProvidedRepos,
 		repoFlagProvidedRepos: repoFlagProvidedRepos,
@@ -163,6 +168,11 @@ func (r *RunStats) GetPullRequests() map[string]string {
 	return r.pulls
 }
 
+// GetDraftPullRequests returns the inner representation of the draft pull requests that were opened during the lifecycle of a given run
+func (r *RunStats) GetDraftPullRequests() map[string]string {
+	return r.draftpulls
+}
+
 // SetFileProvidedRepos sets the number of repos that were provided via file by the user on startup (as opposed to looked up via GitHub API via the --github-org flag)
 func (r *RunStats) SetFileProvidedRepos(fileProvidedRepos []*types.AllowedRepo) {
 	for _, ar := range fileProvidedRepos {
@@ -218,12 +228,22 @@ func TrackEventIfMissing(slice []*github.Repository, repo *github.Repository) []
 	return append(slice, repo)
 }
 
+// TrackPullRequest stores the successful PR opening for the supplied Repo, at the supplied PR URL
+// This function is safe to call from concurrent goroutines
 func (r *RunStats) TrackPullRequest(repoName, prURL string) {
 	defer r.mutex.Unlock()
 	r.mutex.Lock()
 	r.pulls[repoName] = prURL
 }
 
+// TrackDraftPullRequest stores the successful Draft PR opening for the supplied Repo, at the supplied PR URL
+// This function is safe to call from concurrent goroutines
+func (r *RunStats) TrackDraftPullRequest(repoName, prURL string) {
+	defer r.mutex.Unlock()
+	r.mutex.Lock()
+	r.draftpulls[repoName] = prURL
+}
+
 // TrackMultiple accepts a types.Event and a slice of pointers to GitHub repos that will all be associated with that event
 func (r *RunStats) TrackMultiple(event types.Event, repos []*github.Repository) {
 	for _, repo := range repos {
@@ -239,7 +259,8 @@ func (r *RunStats) GenerateRunReport() *types.RunReport {
 		Command:        r.command,
 		SelectionMode:  r.selectionMode,
 		RuntimeSeconds: r.GetTotalRunSeconds(), FileProvidedRepos: r.GetFileProvidedRepos(),
-		PullRequests: r.GetPullRequests(),
+		PullRequests:      r.GetPullRequests(),
+		DraftPullRequests: r.GetDraftPullRequests(),
 	}
 }
 

types/types.go

@@ -23,6 +23,7 @@ type RunReport struct {
 	RuntimeSeconds    int
 	FileProvidedRepos []*AllowedRepo
 	PullRequests      map[string]string
+	DraftPullRequests map[string]string
 }
 
 // AnnotatedEvent is used in printing the final report. It contains the info to print a section's table - both its Event for looking up the tagged repos, and the human-legible description for printing above the table