Prepend [skip ci] to commit messages by default (#89)

- Allow users to opt-out of this behavior via the new --no-skip-ci flag

Author: zackproser

README.md

@@ -412,7 +412,7 @@ echo "gruntwork-io/terragrunt gruntwork-io/terratest" | git-xargs \
 | `--repos`                             | If you want to specify many repos and manage them in files (which makes batching and testing easier) then use this flag to pass the filepath to a repos file. See [the repos file format](#option-2-flat-file-of-repository-names) for more information.                                                                                                                                                                                        | String  | No       |
 | `--repo`                              | Use this flag to specify a single repo, e.g., `--repo gruntwork-io/cloud-nuke`. Can be passed multiple times to target several repos.                                                                                                                                                                                                                                                                                                           | String  | No       |
 | `--github-org`                        | If you want to target every repo in a Github org that your GITHUB_OAUTH_TOKEN has access to, pass the name of the Organization with this flag, to page through every repo via the Github API and target it.                                                                                                                                                                                                                                     | String  | No       |
-| `--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. Default: `git-xargs programmatic commit`.                                                                                                                                                                            | String  | No       |
+| `--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. Default: `[skip ci] git-xargs programmatic commit`. Note that, by default, git-xargs will prepend \"[skip ci]\" to commit messages unless you pass the `--no-skip-ci` flag. If you wish to use an alternative prefix other than [skip ci], you can add the literal string to your --commit-message value.                                                                                                                                                                            | 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! Default: `false`.                                                                                                                                              | Boolean | No       |
 | `--skip-archived-repos`               | If you want to exclude archived (read-only) repositories from the list of targeted repos, pass this flag. Default: `false`.                                                                                                                                                                                                                                                                                                                     | 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. Default: `false`. | Boolean | No       |
@@ -421,6 +421,7 @@ echo "gruntwork-io/terragrunt gruntwork-io/terratest" | git-xargs \
 | `--seconds-between-prs`               | The number of seconds to wait between opening serial pull requests. If you are being rate limited, continue to increase this value until rate limiting eases. Note, this value cannot be negative, so if you pass a value less than 1, the seconds to wait between pull requests will be set to 1 second. Default: `1` second.                                                                                                                 | Integer | No       |
 | `--max-pr-retries`                    | The number of seconds to wait between opening serial pull requests. If you are being rate limited, continue to increase this value until rate limiting eases. Default: `3` seconds.                                                                                                                                                                                                                                                            | Integer | No       |
 | `--seconds-to-wait-when-rate-limited` | The number of seconds to pause once git-xargs has detected it has been rate limited. Note that this buffer is in addition to the value of --seconds-between-prs. If you are regularly being rate limited, increase this value until rate limiting eases. Default: `60` seconds.                                                                                                                                                                | Integer | No       |
+| `--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       |
 
 ## Best practices, tips and tricks
 

cmd/git-xargs.go

@@ -2,6 +2,7 @@ package cmd
 
 import (
 	"bufio"
+	"fmt"
 	"io"
 	"os"
 	"strings"
@@ -38,6 +39,12 @@ func parseGitXargsConfig(c *cli.Context) (*config.GitXargsConfig, error) {
 	config.SecondsToSleepBetweenPRs = c.Int("seconds-between-prs")
 	config.PullRequestRetries = c.Int("max-pr-retries")
 	config.SecondsToSleepWhenRateLimited = c.Int("seconds-to-wait-when-rate-limited")
+	config.NoSkipCI = c.Bool("no-skip-ci")
+	// 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)
+		config.CommitMessage = commitMsgWithCISkip
+	}
 
 	// A non-positive ticker value won't work, so set to the default minimum if user passed a bad value
 	tickerVal := c.Int("seconds-between-prs")

common/common.go

@@ -22,6 +22,7 @@ const (
 	DefaultPullRequestDescription        = "git-xargs programmatic pull request"
 	MaxPullRequestRetriesFlagName        = "max-pr-retries"
 	SecondsToWaitWhenRateLimitedFlagName = "seconds-to-wait-when-rate-limited"
+	NoSkipCIFlagName                     = "no-skip-ci"
 	DefaultMaxConcurrentRepos            = 0
 	DefaultSecondsBetweenPRs             = 1
 	DefaultMaxPullRequestRetries         = 3
@@ -100,4 +101,8 @@ var (
 		Usage: "The number of additional seconds to sleep before attempting to open a PR again, when rate limited by GitHub. Defaults to 60.",
 		Value: DefaultSecondsToWaitWhenRateLimited,
 	}
+	GenericNoSkipCIFlag = cli.BoolFlag{
+		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.",
+	}
 )

config/config.go

@@ -36,6 +36,7 @@ type GitXargsConfig struct {
 	SecondsToSleepBetweenPRs      int
 	PullRequestRetries            int
 	SecondsToSleepWhenRateLimited int
+	NoSkipCI                      bool
 	Ticker                        *time.Ticker
 }
 
@@ -64,11 +65,11 @@ func NewGitXargsConfig() *GitXargsConfig {
 		SecondsToSleepBetweenPRs:      common.DefaultSecondsBetweenPRs,
 		SecondsToSleepWhenRateLimited: common.DefaultSecondsToWaitWhenRateLimited,
 		PullRequestRetries:            common.DefaultMaxPullRequestRetries,
+		NoSkipCI:                      false,
 	}
 }
 
 func NewGitXargsTestConfig() *GitXargsConfig {
-
 	config := NewGitXargsConfig()
 
 	uniqueID := util.RandStringBytes(9)

main.go

@@ -18,12 +18,10 @@ import (
 // For more info, see: http://stackoverflow.com/a/11355611/483528
 var VERSION string
 
-var (
-	LogLevelFlag = cli.StringFlag{
-		Name:  "loglevel",
-		Value: logrus.InfoLevel.String(),
-	}
-)
+var LogLevelFlag = cli.StringFlag{
+	Name:  "loglevel",
+	Value: logrus.InfoLevel.String(),
+}
 
 // initCli initializes the CLI app before any command is actually executed. This function will handle all the setup
 // code, such as setting up the logger with the appropriate log level.
@@ -77,6 +75,7 @@ func setupApp() *cli.App {
 		common.GenericSecondsToWaitFlag,
 		common.GenericMaxPullRequestRetriesFlag,
 		common.GenericSecondsToWaitWhenRateLimitedFlag,
+		common.GenericNoSkipCIFlag,
 	}
 
 	app.Action = cmd.RunGitXargs