feat: Including Regular Expression filter when targeting Github Repositories

cmd/cmd-run.go

@@ -6,6 +6,7 @@ import (
 	"fmt"
 	"os"
 	"os/signal"
+	"regexp"
 	"strings"
 	"syscall"
 
@@ -175,7 +176,22 @@ func run(cmd *cobra.Command, _ []string) error {
 		<-c
 		os.Exit(1)
 	}()
-
+	repoInclude, _ := flag.GetString("repo-include")
+	repoExclude, _ := flag.GetString("repo-exclude")
+	var repoIncludeFilterCompile *regexp.Regexp
+	var repoExcludeFilterCompile *regexp.Regexp
+	if repoInclude != "" {
+		repoIncludeFilterCompile, err = regexp.Compile(repoInclude)
+		if err != nil {
+			return err
+		}
+	}
+	if repoExclude != "" {
+		repoExcludeFilterCompile, err = regexp.Compile(repoExclude)
+		if err != nil {
+			return err
+		}
+	}
 	runner := &multigitter.Runner{
 		ScriptPath:    executablePath,
 		Arguments:     arguments,
@@ -185,25 +201,27 @@ func run(cmd *cobra.Command, _ []string) error {
 
 		VersionController: vc,
 
-		CommitMessage:    commitMessage,
-		PullRequestTitle: prTitle,
-		PullRequestBody:  prBody,
-		Reviewers:        reviewers,
-		TeamReviewers:    teamReviewers,
-		MaxReviewers:     maxReviewers,
-		MaxTeamReviewers: maxTeamReviewers,
-		Interactive:      interactive,
-		DryRun:           dryRun,
-		Fork:             forkMode,
-		ForkOwner:        forkOwner,
-		SkipPullRequest:  skipPullRequest,
-		SkipRepository:   skipRepository,
-		CommitAuthor:     commitAuthor,
-		BaseBranch:       baseBranchName,
-		Assignees:        assignees,
-		ConflictStrategy: conflictStrategy,
-		Draft:            draft,
-		Labels:           labels,
+		CommitMessage:          commitMessage,
+		PullRequestTitle:       prTitle,
+		PullRequestBody:        prBody,
+		Reviewers:              reviewers,
+		TeamReviewers:          teamReviewers,
+		MaxReviewers:           maxReviewers,
+		MaxTeamReviewers:       maxTeamReviewers,
+		Interactive:            interactive,
+		DryRun:                 dryRun,
+		Fork:                   forkMode,
+		ForkOwner:              forkOwner,
+		SkipPullRequest:        skipPullRequest,
+		SkipRepository:         skipRepository,
+		RegExExcludeRepository: repoExcludeFilterCompile,
+		RegExIncludeRepository: repoIncludeFilterCompile,
+		CommitAuthor:           commitAuthor,
+		BaseBranch:             baseBranchName,
+		Assignees:              assignees,
+		ConflictStrategy:       conflictStrategy,
+		Draft:                  draft,
+		Labels:                 labels,
 
 		Concurrent: concurrent,
 

cmd/platform.go

@@ -28,6 +28,8 @@ func configurePlatform(cmd *cobra.Command) {
 	flags.StringSliceP("group", "G", nil, "The name of a GitLab organization. All repositories in that group will be used.")
 	flags.StringSliceP("user", "U", nil, "The name of a user. All repositories owned by that user will be used.")
 	flags.StringSliceP("repo", "R", nil, "The name, including owner of a GitHub repository in the format \"ownerName/repoName\".")
+	flags.StringP("repo-include", "", "", "Include repositories that match with a given Regular Expression")
+	flags.StringP("repo-exclude", "", "", "Exclude repositories that match with a given Regular Expression")
 	flags.StringP("repo-search", "", "", "Use a repository search to find repositories to target (GitHub only). Forks are NOT included by default, use `fork:true` to include them. See the GitHub documentation for full syntax: https://docs.github.com/en/search-github/searching-on-github/searching-for-repositories")
 	flags.StringSliceP("topic", "", nil, "The topic of a GitHub/GitLab/Gitea repository. All repositories having at least one matching topic are targeted.")
 	flags.StringSliceP("project", "P", nil, "The name, including owner of a GitLab project in the format \"ownerName/repoName\".")
@@ -129,7 +131,6 @@ func createGithubClient(flag *flag.FlagSet, verifyFlags bool, readOnly bool) (mu
 	forkOwner, _ := flag.GetString("fork-owner")
 	sshAuth, _ := flag.GetBool("ssh-auth")
 	skipForks, _ := flag.GetBool("skip-forks")
-
 	if verifyFlags && len(orgs) == 0 && len(users) == 0 && len(repos) == 0 && repoSearch == "" {
 		return nil, errors.New("no organization, user, repo or repo-search set")
 	}
@@ -160,7 +161,6 @@ func createGithubClient(flag *flag.FlagSet, verifyFlags bool, readOnly bool) (mu
 	if err != nil {
 		return nil, err
 	}
-
 	vc, err := github.New(github.Config{
 		Token:               token,
 		BaseURL:             gitBaseURL,

internal/multigitter/run.go

@@ -7,6 +7,7 @@ import (
 	"math/rand"
 	"os"
 	"os/exec"
+	"regexp"
 	"sync"
 	"syscall"
 
@@ -54,12 +55,13 @@ type Runner struct {
 	BaseBranch       string // The base branch of the PR, use default branch if not set
 	Assignees        []string
 
-	Concurrent      int
-	SkipPullRequest bool     // If set, the script will run directly on the base-branch without creating any PR
-	SkipRepository  []string // A list of repositories that run will skip
-
-	Fork      bool   // If set, create a fork and make the pull request from it
-	ForkOwner string // The owner of the new fork. If empty, the fork should happen on the logged in user
+	Concurrent             int
+	SkipPullRequest        bool     // If set, the script will run directly on the base-branch without creating any PR
+	SkipRepository         []string // A list of repositories that run will skip
+	RegExIncludeRepository *regexp.Regexp
+	RegExExcludeRepository *regexp.Regexp
+	Fork                   bool   // If set, create a fork and make the pull request from it
+	ForkOwner              string // The owner of the new fork. If empty, the fork should happen on the logged in user
 
 	ConflictStrategy ConflictStrategy // Defines what will happen if a branch already exists
 
@@ -97,8 +99,7 @@ func (r *Runner) Run(ctx context.Context) error {
 	if err != nil {
 		return errors.Wrap(err, "could not fetch repositories")
 	}
-
-	repos = filterRepositories(repos, r.SkipRepository)
+	repos = filterRepositories(repos, r.SkipRepository, r.RegExIncludeRepository, r.RegExExcludeRepository)
 
 	if len(repos) == 0 {
 		log.Infof("No repositories found. Please make sure the user of the token has the correct access to the repos you want to change.")
@@ -152,15 +153,33 @@ func (r *Runner) Run(ctx context.Context) error {
 	return nil
 }
 
-func filterRepositories(repos []scm.Repository, skipRepositoryNames []string) []scm.Repository {
+// Determines if Repository should be excluded based on provided Regular Expression
+func excludeRepositoryFilter(repoName string, regExp *regexp.Regexp) bool {
+	if regExp == nil {
+		return false
+	}
+	return regExp.MatchString(repoName)
+}
+
+// Determines if Repository should be included based on provided Regular Expression
+func matchesRepositoryFilter(repoName string, regExp *regexp.Regexp) bool {
+	if regExp == nil {
+		return true
+	}
+	return regExp.MatchString(repoName)
+}
+
+func filterRepositories(repos []scm.Repository, skipRepositoryNames []string, regExIncludeRepository *regexp.Regexp,
+	regExExcludeRepository *regexp.Regexp) []scm.Repository {
 	skipReposMap := map[string]struct{}{}
 	for _, skipRepo := range skipRepositoryNames {
 		skipReposMap[skipRepo] = struct{}{}
 	}
 
 	filteredRepos := make([]scm.Repository, 0, len(repos))
 	for _, r := range repos {
-		if _, shouldSkip := skipReposMap[r.FullName()]; !shouldSkip {
+		if _, shouldSkip := skipReposMap[r.FullName()]; !shouldSkip && (matchesRepositoryFilter(r.FullName(),
+			regExIncludeRepository) && !excludeRepositoryFilter(r.FullName(), regExExcludeRepository)) {
 			filteredRepos = append(filteredRepos, r)
 		} else {
 			log.Infof("Skipping %s", r.FullName())

tests/table_test.go

@@ -336,6 +336,32 @@ func TestTable(t *testing.T) {
 				assert.False(t, branchExist(t, vcMock.Repositories[0].Path, "custom-branch-name"))
 			},
 		},
+		{
+			name: "regex repository filtering",
+			vcCreate: func(t *testing.T) *vcmock.VersionController {
+				return &vcmock.VersionController{
+					Repositories: []vcmock.Repository{
+						createRepo(t, "owner", "repo1", "i like apples"),
+						createRepo(t, "owner", "repo-2", "i like oranges"),
+						createRepo(t, "owner", "repo-change", "i like carrots"),
+						createRepo(t, "owner", "repo-3", "i like carrots"),
+					},
+				}
+			},
+			args: []string{
+				"run",
+				"--repo-search", "repo",
+				"--repo-include", "^owner/repo-",
+				"--repo-exclude", "\\d$",
+				"--commit-message", "chore: foo",
+				"--dry-run",
+				changerBinaryPath,
+			},
+			verify: func(t *testing.T, vcMock *vcmock.VersionController, runData runData) {
+				require.Len(t, vcMock.PullRequests, 0)
+				assert.Contains(t, runData.logOut, "Running on 1 repositories")
+			},
+		},
 
 		{
 			name:      "parallel",