Merge pull request #30 from github/feat/autoclose

Implement Autoclose Feature

Author: GrantBirki

README.md

@@ -126,6 +126,14 @@ By using the `--minimum` flag you can require a minimum number of pull requests
 gh combine owner/repo --minimum 3
 ```
 
+### Do Not Auto-Close Linked PRs
+
+By default, the source pull requests that are combined into the new pull request will be automatically closed when the combined Pr merges by adding the `closes` keyword to the new pull request. This can be disabled by using the `--no-autoclose` flag.
+
+```bash
+gh combine owner/repo --no-autoclose
+```
+
 ### Only Combine Pull Requests that match a given Label(s)
 
 ```bash

internal/cmd/combine_prs.go

@@ -71,10 +71,12 @@ func CombinePRsWithStats(ctx context.Context, graphQlClient *api.GraphQLClient,
 		}
 	}
 
+	combinedPrNumbers := []string{}
 	for _, pr := range opts.Pulls {
 		if opts.Noop {
 			Logger.Debug("Simulating merge of branch", "branch", pr.Head.Ref)
 			combined = append(combined, fmt.Sprintf("#%d - %s", pr.Number, pr.Title))
+			combinedPrNumbers = append(combinedPrNumbers, fmt.Sprintf("#%d", pr.Number))
 		} else {
 			err := mergeBranch(ctx, restClient, opts.Repo, workingBranchName, pr.Head.Ref)
 			if err != nil {
@@ -87,6 +89,7 @@ func CombinePRsWithStats(ctx context.Context, graphQlClient *api.GraphQLClient,
 			} else {
 				Logger.Debug("Merged branch", "branch", pr.Head.Ref)
 				combined = append(combined, fmt.Sprintf("#%d - %s", pr.Number, pr.Title))
+				combinedPrNumbers = append(combinedPrNumbers, fmt.Sprintf("#%d", pr.Number))
 			}
 		}
 	}
@@ -102,7 +105,7 @@ func CombinePRsWithStats(ctx context.Context, graphQlClient *api.GraphQLClient,
 			Logger.Warn("Failed to delete working branch", "branch", workingBranchName, "error", err)
 		}
 
-		prBody := generatePRBody(combined, mergeConflicts, opts.Command)
+		prBody := generatePRBody(combinedPrNumbers, mergeConflicts, opts.Command)
 		prTitle := "Combined PRs"
 		prNumber, prErr := createPullRequestWithNumber(ctx, restClient, opts.Repo, prTitle, combineBranchName, repoDefaultBranch, prBody, addLabels, addAssignees)
 		if prErr != nil {
@@ -200,12 +203,19 @@ func getBranchSHA(ctx context.Context, client RESTClientInterface, repo github.R
 	return ref.Object.SHA, nil
 }
 
-// Updated generatePRBody to include the command used
-func generatePRBody(combinedPRs, mergeFailedPRs []string, command string) string {
+// Updated generatePRBody to include the command used and handle PR autoclose logic
+// combinedPrNumbers looks like ["#1", "#2"]
+// mergeFailedPRs looks like ["#3", "#4"]
+func generatePRBody(combinedPrNumbers []string, mergeFailedPRs []string, command string) string {
 	body := "✅ The following pull requests have been successfully combined:\n"
-	for _, pr := range combinedPRs {
-		body += "- " + pr + "\n"
+	for _, prNumber := range combinedPrNumbers {
+		prRef := prNumber
+		if !noAutoclose {
+			prRef = "closes: " + prNumber
+		}
+		body += "- " + prRef + "\n"
 	}
+
 	if len(mergeFailedPRs) > 0 {
 		body += "\n⚠️ The following pull requests could not be merged due to conflicts:\n"
 		for _, pr := range mergeFailedPRs {

internal/cmd/root.go

@@ -27,7 +27,7 @@ var (
 
 	requireCI           bool
 	mustBeApproved      bool
-	autoclose           bool
+	noAutoclose         bool
 	updateBranch        bool
 	reposFile           string
 	minimum             int
@@ -116,7 +116,7 @@ func NewRootCmd() *cobra.Command {
     
       # Additional options
 	  gh combine owner/repo --dry-run                           # Simulate the actions without making any changes
-      gh combine owner/repo --autoclose                         # Close source PRs when combined PR is merged
+      gh combine owner/repo --no-autoclose                      # Do not auto-close source PRs when combined PR is merged via the closes keyword
 	  gh combine owner/repo --base-branch main                  # Use a different base branch for the combined PR
 	  gh combine owner/repo --no-color                          # Disable color output
 	  gh combine owner/repo --no-stats                          # Disable stats summary display
@@ -145,7 +145,7 @@ func NewRootCmd() *cobra.Command {
 	rootCmd.Flags().BoolVar(&requireCI, "require-ci", false, "Only include PRs with passing CI checks")
 	rootCmd.Flags().BoolVar(&dependabot, "dependabot", false, "Only include PRs with the dependabot branch prefix")
 	rootCmd.Flags().BoolVar(&mustBeApproved, "require-approved", false, "Only include PRs that have been approved")
-	rootCmd.Flags().BoolVar(&autoclose, "autoclose", false, "Close source PRs when combined PR is merged")
+	rootCmd.Flags().BoolVar(&noAutoclose, "no-autoclose", false, "Do not auto-close source PRs when combined PR is merged")
 	rootCmd.Flags().BoolVar(&updateBranch, "update-branch", false, "Update the branch of the combined PR if possible")
 	rootCmd.Flags().StringVar(&baseBranch, "base-branch", "main", "Base branch for the combined PR (default: main)")
 	rootCmd.Flags().StringVar(&combineBranchName, "combine-branch-name", "combined-prs", "Name of the combined PR branch")
@@ -454,8 +454,8 @@ func buildCommandString(args []string) string {
 	if mustBeApproved {
 		cmd = append(cmd, "--require-approved")
 	}
-	if autoclose {
-		cmd = append(cmd, "--autoclose")
+	if noAutoclose {
+		cmd = append(cmd, "--no-autoclose")
 	}
 	if updateBranch {
 		cmd = append(cmd, "--update-branch")

script/test

@@ -6,5 +6,5 @@ set -e
 if ! command -v tparse &> /dev/null; then
   go test -v -cover ./...
 else
-  set -o pipefail && go test -json ./... | tparse -all -trimpath github.com/github/
+  set -o pipefail && go test -cover -coverprofile=coverage.out -json ./... | tparse -all -trimpath github.com/github/
 fi