feat: improve the display of repositories pr url at the end (#307)

JordanGoasdoue · web-flow · commit a8be14e72584 · 2024-03-29T14:07:57.000+01:00
diff --git a/main.go b/main.go
@@ -163,8 +163,9 @@ func main() {
 			updated, pr, err := repo.Update(ctx, updaters, options.UpdateOptions)
 
 			result := repository.RepoUpdateResult{
-				Owner: repo.Owner,
-				Repo:  repo.Name,
+				Owner:     repo.Owner,
+				Repo:      repo.Name,
+				IsUpdated: updated,
 			}
 
 			if err != nil {
@@ -201,27 +202,55 @@ func main() {
 
 	logrus.WithField("repositories-count", len(repositories)).Info("Updates finished")
 
-	resultFile := repository.ResultFile{}
-	hadError := false
+	updatedPRURLs, notUpdatedPRURLs, resultFile, hadError := processResults(results)
 
+	logUpdatesSummary(updatedPRURLs, notUpdatedPRURLs)
+
+	if options.outputResults != "" {
+		err := writeResults(&resultFile, options.outputResults)
+		if err != nil {
+			logrus.Fatalf("Failed to write results: %s", err)
+		}
+	}
+
+	if options.failOnError && hadError {
+		logrus.Fatal("Some repository updates failed")
+	}
+}
+
+func processResults(results chan repository.RepoUpdateResult) (updatedPRURLs []string, notUpdatedPRURLs []string, resultFile repository.ResultFile, hadError bool) {
 	for r := range results {
+		if r.PullRequest != nil && r.PullRequest.URL != "" {
+			if r.IsUpdated {
+				updatedPRURLs = append(updatedPRURLs, r.PullRequest.URL)
+			} else {
+				notUpdatedPRURLs = append(notUpdatedPRURLs, r.PullRequest.URL)
+			}
+		}
+
 		resultFile.Repos = append(resultFile.Repos, r)
 
 		if r.Error != nil {
 			hadError = true
 		}
 	}
 
-	if options.outputResults != "" {
-		err := writeResults(&resultFile, options.outputResults)
+	return updatedPRURLs, notUpdatedPRURLs, resultFile, hadError
+}
 
-		if err != nil {
-			logrus.Fatalf("Failed to write results: %s", err)
+func logUpdatesSummary(updatedPRURLs, notUpdatedPRURLs []string) {
+	if len(notUpdatedPRURLs) > 0 {
+		logrus.WithField("unrevised-repository-count", len(notUpdatedPRURLs)).Info("Update summary (Unrevised)")
+		for _, url := range notUpdatedPRURLs {
+			logrus.WithField("unrevised-repository-pr-url", url).Info("Update summary (Unrevised)")
 		}
 	}
 
-	if options.failOnError && hadError {
-		logrus.Fatal("Some repository updates failed")
+	if len(updatedPRURLs) > 0 {
+		logrus.WithField("updated-repository-count", len(updatedPRURLs)).Info("Update summary (Updated)")
+		for _, url := range updatedPRURLs {
+			logrus.WithField("updated-repository-pr-url", url).Info("Update summary (Updated)")
+		}
 	}
 }
 
diff --git a/repository/result.go b/repository/result.go
@@ -9,6 +9,7 @@ type RepoUpdateResult struct {
 	Repo        string             `json:"repo"`
 	Error       *string            `json:"error"`
 	PullRequest *PullRequestResult `json:"pr"`
+	IsUpdated   bool
 }
 
 type PullRequestResult struct {
diff --git a/repository/strategy_append.go b/repository/strategy_append.go
@@ -44,44 +44,44 @@ func (s *AppendStrategy) Run(ctx context.Context) (bool, *github.PullRequest, er
 		})
 	}
 	if err != nil {
-		return false, nil, fmt.Errorf("failed to switch to branch %s: %w", branchName, err)
+		return false, existingPR, fmt.Errorf("failed to switch to branch %s: %w", branchName, err)
 	}
 
 	repoUpdated, err := s.Repository.runUpdaters(ctx, s.Updaters, s.RepoPath)
 	if err != nil {
-		return false, nil, fmt.Errorf("failed to update repository %s: %w", s.Repository.FullName(), err)
+		return false, existingPR, fmt.Errorf("failed to update repository %s: %w", s.Repository.FullName(), err)
 	}
 	if !repoUpdated {
-		return false, nil, nil
+		return false, existingPR, nil
 	}
 
 	if err = s.Options.Git.setDefaultValues(s.Updaters, templateExecutorFor(s.Options, s.Repository, s.RepoPath)); err != nil {
-		return false, nil, fmt.Errorf("failed to set default git values: %w", err)
+		return false, existingPR, fmt.Errorf("failed to set default git values: %w", err)
 	}
 	if err = s.Options.GitHub.setDefaultValues(s.Options.Git, templateExecutorFor(s.Options, s.Repository, s.RepoPath)); err != nil {
-		return false, nil, fmt.Errorf("failed to set default github values: %w", err)
+		return false, existingPR, fmt.Errorf("failed to set default github values: %w", err)
 	}
 	s.Options.GitHub.setDefaultUpdateOperation(IgnoreUpdateOperation)
 
 	changesCommitted, err := commitChanges(ctx, gitRepo, s.Options)
 	if err != nil {
-		return false, nil, fmt.Errorf("failed to commit changes to git repository %s: %w", s.Repository.FullName(), err)
+		return false, existingPR, fmt.Errorf("failed to commit changes to git repository %s: %w", s.Repository.FullName(), err)
 	}
 	if !changesCommitted {
 		logrus.WithField("repository", s.Repository.FullName()).Debug("No changes recorded, nothing to push")
-		return false, nil, nil
+		return false, existingPR, nil
 	}
 	if s.Options.DryRun {
 		logrus.WithField("repository", s.Repository.FullName()).Warning("Running in dry-run mode, not pushing changes")
-		return false, nil, nil
+		return false, existingPR, nil
 	}
 
 	err = pushChanges(ctx, gitRepo, pushOptions{
 		GitHubOpts: s.Options.GitHub,
 		BranchName: branchName,
 	})
 	if err != nil {
-		return false, nil, fmt.Errorf("failed to push changes to git repository %s: %w", s.Repository.FullName(), err)
+		return false, existingPR, fmt.Errorf("failed to push changes to git repository %s: %w", s.Repository.FullName(), err)
 	}
 
 	var pr *github.PullRequest
@@ -91,7 +91,7 @@ func (s *AppendStrategy) Run(ctx context.Context) (bool, *github.PullRequest, er
 		pr, err = s.Repository.createPullRequest(ctx, s.Options.GitHub, branchName)
 	}
 	if err != nil {
-		return false, nil, fmt.Errorf("failed to create or update Pull Request: %w", err)
+		return false, existingPR, fmt.Errorf("failed to create or update Pull Request: %w", err)
 	}
 
 	return true, pr, nil
diff --git a/repository/strategy_reset.go b/repository/strategy_reset.go
@@ -42,36 +42,36 @@ func (s *ResetStrategy) Run(ctx context.Context) (bool, *github.PullRequest, err
 		CreateBranch: true,
 	})
 	if err != nil {
-		return false, nil, fmt.Errorf("failed to switch to branch %s: %w", branchName, err)
+		return false, existingPR, fmt.Errorf("failed to switch to branch %s: %w", branchName, err)
 	}
 
 	repoUpdated, err := s.Repository.runUpdaters(ctx, s.Updaters, s.RepoPath)
 	if err != nil {
-		return false, nil, fmt.Errorf("failed to update repository %s: %w", s.Repository.FullName(), err)
+		return false, existingPR, fmt.Errorf("failed to update repository %s: %w", s.Repository.FullName(), err)
 	}
 	if !repoUpdated {
-		return false, nil, nil
+		return false, existingPR, nil
 	}
 
 	if err = s.Options.Git.setDefaultValues(s.Updaters, templateExecutorFor(s.Options, s.Repository, s.RepoPath)); err != nil {
-		return false, nil, fmt.Errorf("failed to set default git values: %w", err)
+		return false, existingPR, fmt.Errorf("failed to set default git values: %w", err)
 	}
 	if err = s.Options.GitHub.setDefaultValues(s.Options.Git, templateExecutorFor(s.Options, s.Repository, s.RepoPath)); err != nil {
-		return false, nil, fmt.Errorf("failed to set default github values: %w", err)
+		return false, existingPR, fmt.Errorf("failed to set default github values: %w", err)
 	}
 	s.Options.GitHub.setDefaultUpdateOperation(ReplaceUpdateOperation)
 
 	changesCommitted, err := commitChanges(ctx, gitRepo, s.Options)
 	if err != nil {
-		return false, nil, fmt.Errorf("failed to commit changes to git repository %s: %w", s.Repository.FullName(), err)
+		return false, existingPR, fmt.Errorf("failed to commit changes to git repository %s: %w", s.Repository.FullName(), err)
 	}
 	if !changesCommitted {
 		logrus.WithField("repository", s.Repository.FullName()).Debug("No changes recorded, nothing to push")
-		return false, nil, nil
+		return false, existingPR, nil
 	}
 	if s.Options.DryRun {
 		logrus.WithField("repository", s.Repository.FullName()).Warning("Running in dry-run mode, not pushing changes")
-		return false, nil, nil
+		return false, existingPR, nil
 	}
 
 	err = pushChanges(ctx, gitRepo, pushOptions{
@@ -80,7 +80,7 @@ func (s *ResetStrategy) Run(ctx context.Context) (bool, *github.PullRequest, err
 		ForcePush:  true,
 	})
 	if err != nil {
-		return false, nil, fmt.Errorf("failed to push changes to git repository %s: %w", s.Repository.FullName(), err)
+		return false, existingPR, fmt.Errorf("failed to push changes to git repository %s: %w", s.Repository.FullName(), err)
 	}
 
 	var pr *github.PullRequest
@@ -90,7 +90,7 @@ func (s *ResetStrategy) Run(ctx context.Context) (bool, *github.PullRequest, err
 		pr, err = s.Repository.createPullRequest(ctx, s.Options.GitHub, branchName)
 	}
 	if err != nil {
-		return false, nil, fmt.Errorf("failed to create or update Pull Request: %w", err)
+		return false, existingPR, fmt.Errorf("failed to create or update Pull Request: %w", err)
 	}
 
 	return true, pr, nil

Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,7 @@ type RepoUpdateResult struct {`
`9`	`9`	Repo string `json:"repo"`
`10`	`10`	Error *string `json:"error"`
`11`	`11`	PullRequest *PullRequestResult `json:"pr"`
	`12`	`+ IsUpdated bool`
`12`	`13`	`}`
`13`	`14`
`14`	`15`	`type PullRequestResult struct {`
Original file line number	Diff line number	Diff line change
`@@ -44,44 +44,44 @@ func (s AppendStrategy) Run(ctx context.Context) (bool, github.PullRequest, er`
`44`	`44`	`})`
`45`	`45`	`}`
`46`	`46`	`if err != nil {`
`47`		`- return false, nil, fmt.Errorf("failed to switch to branch %s: %w", branchName, err)`
	`47`	`+ return false, existingPR, fmt.Errorf("failed to switch to branch %s: %w", branchName, err)`
`48`	`48`	`}`
`49`	`49`
`50`	`50`	`repoUpdated, err := s.Repository.runUpdaters(ctx, s.Updaters, s.RepoPath)`
`51`	`51`	`if err != nil {`
`52`		`- return false, nil, fmt.Errorf("failed to update repository %s: %w", s.Repository.FullName(), err)`
	`52`	`+ return false, existingPR, fmt.Errorf("failed to update repository %s: %w", s.Repository.FullName(), err)`
`53`	`53`	`}`
`54`	`54`	`if !repoUpdated {`
`55`		`- return false, nil, nil`
	`55`	`+ return false, existingPR, nil`
`56`	`56`	`}`
`57`	`57`
`58`	`58`	`if err = s.Options.Git.setDefaultValues(s.Updaters, templateExecutorFor(s.Options, s.Repository, s.RepoPath)); err != nil {`
`59`		`- return false, nil, fmt.Errorf("failed to set default git values: %w", err)`
	`59`	`+ return false, existingPR, fmt.Errorf("failed to set default git values: %w", err)`
`60`	`60`	`}`
`61`	`61`	`if err = s.Options.GitHub.setDefaultValues(s.Options.Git, templateExecutorFor(s.Options, s.Repository, s.RepoPath)); err != nil {`
`62`		`- return false, nil, fmt.Errorf("failed to set default github values: %w", err)`
	`62`	`+ return false, existingPR, fmt.Errorf("failed to set default github values: %w", err)`
`63`	`63`	`}`
`64`	`64`	`s.Options.GitHub.setDefaultUpdateOperation(IgnoreUpdateOperation)`
`65`	`65`
`66`	`66`	`changesCommitted, err := commitChanges(ctx, gitRepo, s.Options)`
`67`	`67`	`if err != nil {`
`68`		`- return false, nil, fmt.Errorf("failed to commit changes to git repository %s: %w", s.Repository.FullName(), err)`
	`68`	`+ return false, existingPR, fmt.Errorf("failed to commit changes to git repository %s: %w", s.Repository.FullName(), err)`
`69`	`69`	`}`
`70`	`70`	`if !changesCommitted {`
`71`	`71`	`logrus.WithField("repository", s.Repository.FullName()).Debug("No changes recorded, nothing to push")`
`72`		`- return false, nil, nil`
	`72`	`+ return false, existingPR, nil`
`73`	`73`	`}`
`74`	`74`	`if s.Options.DryRun {`
`75`	`75`	`logrus.WithField("repository", s.Repository.FullName()).Warning("Running in dry-run mode, not pushing changes")`
`76`		`- return false, nil, nil`
	`76`	`+ return false, existingPR, nil`
`77`	`77`	`}`
`78`	`78`
`79`	`79`	`err = pushChanges(ctx, gitRepo, pushOptions{`
`80`	`80`	`GitHubOpts: s.Options.GitHub,`
`81`	`81`	`BranchName: branchName,`
`82`	`82`	`})`
`83`	`83`	`if err != nil {`
`84`		`- return false, nil, fmt.Errorf("failed to push changes to git repository %s: %w", s.Repository.FullName(), err)`
	`84`	`+ return false, existingPR, fmt.Errorf("failed to push changes to git repository %s: %w", s.Repository.FullName(), err)`
`85`	`85`	`}`
`86`	`86`
`87`	`87`	`var pr *github.PullRequest`
`@@ -91,7 +91,7 @@ func (s AppendStrategy) Run(ctx context.Context) (bool, github.PullRequest, er`
`91`	`91`	`pr, err = s.Repository.createPullRequest(ctx, s.Options.GitHub, branchName)`
`92`	`92`	`}`
`93`	`93`	`if err != nil {`
`94`		`- return false, nil, fmt.Errorf("failed to create or update Pull Request: %w", err)`
	`94`	`+ return false, existingPR, fmt.Errorf("failed to create or update Pull Request: %w", err)`
`95`	`95`	`}`
`96`	`96`
`97`	`97`	`return true, pr, nil`
Original file line number	Diff line number	Diff line change
`@@ -42,36 +42,36 @@ func (s ResetStrategy) Run(ctx context.Context) (bool, github.PullRequest, err`
`42`	`42`	`CreateBranch: true,`
`43`	`43`	`})`
`44`	`44`	`if err != nil {`
`45`		`- return false, nil, fmt.Errorf("failed to switch to branch %s: %w", branchName, err)`
	`45`	`+ return false, existingPR, fmt.Errorf("failed to switch to branch %s: %w", branchName, err)`
`46`	`46`	`}`
`47`	`47`
`48`	`48`	`repoUpdated, err := s.Repository.runUpdaters(ctx, s.Updaters, s.RepoPath)`
`49`	`49`	`if err != nil {`
`50`		`- return false, nil, fmt.Errorf("failed to update repository %s: %w", s.Repository.FullName(), err)`
	`50`	`+ return false, existingPR, fmt.Errorf("failed to update repository %s: %w", s.Repository.FullName(), err)`
`51`	`51`	`}`
`52`	`52`	`if !repoUpdated {`
`53`		`- return false, nil, nil`
	`53`	`+ return false, existingPR, nil`
`54`	`54`	`}`
`55`	`55`
`56`	`56`	`if err = s.Options.Git.setDefaultValues(s.Updaters, templateExecutorFor(s.Options, s.Repository, s.RepoPath)); err != nil {`
`57`		`- return false, nil, fmt.Errorf("failed to set default git values: %w", err)`
	`57`	`+ return false, existingPR, fmt.Errorf("failed to set default git values: %w", err)`
`58`	`58`	`}`
`59`	`59`	`if err = s.Options.GitHub.setDefaultValues(s.Options.Git, templateExecutorFor(s.Options, s.Repository, s.RepoPath)); err != nil {`
`60`		`- return false, nil, fmt.Errorf("failed to set default github values: %w", err)`
	`60`	`+ return false, existingPR, fmt.Errorf("failed to set default github values: %w", err)`
`61`	`61`	`}`
`62`	`62`	`s.Options.GitHub.setDefaultUpdateOperation(ReplaceUpdateOperation)`
`63`	`63`
`64`	`64`	`changesCommitted, err := commitChanges(ctx, gitRepo, s.Options)`
`65`	`65`	`if err != nil {`
`66`		`- return false, nil, fmt.Errorf("failed to commit changes to git repository %s: %w", s.Repository.FullName(), err)`
	`66`	`+ return false, existingPR, fmt.Errorf("failed to commit changes to git repository %s: %w", s.Repository.FullName(), err)`
`67`	`67`	`}`
`68`	`68`	`if !changesCommitted {`
`69`	`69`	`logrus.WithField("repository", s.Repository.FullName()).Debug("No changes recorded, nothing to push")`
`70`		`- return false, nil, nil`
	`70`	`+ return false, existingPR, nil`
`71`	`71`	`}`
`72`	`72`	`if s.Options.DryRun {`
`73`	`73`	`logrus.WithField("repository", s.Repository.FullName()).Warning("Running in dry-run mode, not pushing changes")`
`74`		`- return false, nil, nil`
	`74`	`+ return false, existingPR, nil`
`75`	`75`	`}`
`76`	`76`
`77`	`77`	`err = pushChanges(ctx, gitRepo, pushOptions{`
`@@ -80,7 +80,7 @@ func (s ResetStrategy) Run(ctx context.Context) (bool, github.PullRequest, err`
`80`	`80`	`ForcePush: true,`
`81`	`81`	`})`
`82`	`82`	`if err != nil {`
`83`		`- return false, nil, fmt.Errorf("failed to push changes to git repository %s: %w", s.Repository.FullName(), err)`
	`83`	`+ return false, existingPR, fmt.Errorf("failed to push changes to git repository %s: %w", s.Repository.FullName(), err)`
`84`	`84`	`}`
`85`	`85`
`86`	`86`	`var pr *github.PullRequest`
`@@ -90,7 +90,7 @@ func (s ResetStrategy) Run(ctx context.Context) (bool, github.PullRequest, err`
`90`	`90`	`pr, err = s.Repository.createPullRequest(ctx, s.Options.GitHub, branchName)`
`91`	`91`	`}`
`92`	`92`	`if err != nil {`
`93`		`- return false, nil, fmt.Errorf("failed to create or update Pull Request: %w", err)`
	`93`	`+ return false, existingPR, fmt.Errorf("failed to create or update Pull Request: %w", err)`
`94`	`94`	`}`
`95`	`95`
`96`	`96`	`return true, pr, nil`