avoid unnecessary pr update calls (#738)

tulioz · web-flow · commit 13b8bf5bdb3a · 2026-05-05T19:02:49.000Z
resending unchanged fields like BaseRefName makes github fire extra pull_request webhooks, doubling workflow runs in consumer repos.
diff --git a/.gitignore b/.gitignore
@@ -20,4 +20,4 @@ man/
 # Output of the go coverage tool, specifically when used with LiteIDE
 *.out
 cmd/av/av
-.claude/settings.local.json
+.claude/
diff --git a/cmd/av/auth.go b/cmd/av/auth.go
@@ -44,7 +44,8 @@ func checkAviatorAuthStatus(ctx context.Context) error {
 		return errors.Wrap(err, "Failed to query Aviator")
 	}
 
-	fmt.Fprint(os.Stderr,
+	fmt.Fprint(
+		os.Stderr,
 		"Logged in to Aviator as ", colors.UserInput(query.Viewer.FullName),
 		" (", colors.UserInput(query.Viewer.Email), ").\n",
 	)
@@ -69,7 +70,8 @@ func checkGitHubAuthStatus(ctx context.Context) error {
 		return errors.Wrap(err, "Failed to query GitHub")
 	}
 
-	fmt.Fprint(os.Stderr,
+	fmt.Fprint(
+		os.Stderr,
 		"Logged in to GitHub as ", colors.UserInput(viewer.Name),
 		" (", colors.UserInput(viewer.Login), ").\n",
 	)
diff --git a/cmd/av/branch.go b/cmd/av/branch.go
@@ -368,7 +368,8 @@ func createBranch(
 	// On failure, we want to delete the branch we created so that the user
 	// can try again (e.g., to fix issues surfaced by a pre-commit hook).
 	cu.Add(func() {
-		fmt.Fprint(os.Stderr,
+		fmt.Fprint(
+			os.Stderr,
 			colors.Faint("  - Cleaning up branch "),
 			colors.UserInput(branchName),
 			colors.Faint(" because commit was not successful."),
diff --git a/cmd/av/commit.go b/cmd/av/commit.go
@@ -114,7 +114,8 @@ func runCreate(ctx context.Context, repo *git.Repo, db meta.DB) error {
 			ExitError: true,
 		})
 		if err != nil {
-			fmt.Fprint(os.Stderr,
+			fmt.Fprint(
+				os.Stderr,
 				"\n", colors.Failure("Failed to stage files: ", err.Error()), "\n",
 			)
 			return actions.ErrExitSilently{ExitCode: 1}
@@ -217,7 +218,8 @@ func runAmend(
 			ExitError: true,
 		})
 		if err != nil {
-			fmt.Fprint(os.Stderr,
+			fmt.Fprint(
+				os.Stderr,
 				"\n", colors.Failure("Failed to stage files: ", err.Error()), "\n",
 			)
 			return actions.ErrExitSilently{ExitCode: 1}
@@ -292,7 +294,8 @@ func branchAndCommit(
 			ExitError: true,
 		})
 		if err != nil {
-			fmt.Fprint(os.Stderr,
+			fmt.Fprint(
+				os.Stderr,
 				"\n", colors.Failure("Failed to stage files: ", err.Error()), "\n",
 			)
 			return actions.ErrExitSilently{ExitCode: 1}
@@ -309,7 +312,8 @@ func branchAndCommit(
 		ExitError:   true,
 		Interactive: true,
 	}); err != nil {
-		fmt.Fprint(os.Stderr,
+		fmt.Fprint(
+			os.Stderr,
 			"\n", colors.Failure("Failed to create commit."), "\n",
 		)
 		return actions.ErrExitSilently{ExitCode: 1}
diff --git a/cmd/av/diff.go b/cmd/av/diff.go
@@ -113,7 +113,8 @@ Generates the diff between the working tree and the parent branch
 		// We need to display this **after** the diff to ensure that the diff
 		// output pager doesn't eat this message.
 		if notUpToDate {
-			fmt.Fprint(os.Stderr,
+			fmt.Fprint(
+				os.Stderr,
 				colors.Warning("\nWARNING: Branch "), colors.UserInput(currentBranchName),
 				colors.Warning(" is not up to date with parent branch "),
 				colors.UserInput(branch.Parent.Name), colors.Warning(". Run "),
diff --git a/cmd/av/helpers.go b/cmd/av/helpers.go
@@ -71,7 +71,8 @@ func getOrCreateDB(repo *git.Repo) (meta.DB, bool, error) {
 	dbPath := filepath.Join(repo.AvDir(), "av.db")
 	db, exists, err := jsonfiledb.OpenPath(dbPath)
 	if err != nil {
-		return nil, false, errors.WrapIff(err,
+		return nil, false, errors.WrapIff(
+			err,
 			"failed to open av database at %q (the file may be corrupted; try deleting it and running 'av init')",
 			dbPath,
 		)
diff --git a/cmd/av/pr.go b/cmd/av/pr.go
@@ -419,7 +419,8 @@ func init() {
 	)
 	prCmd.Flags().BoolVar(
 		&prFlags.Current, "current", false,
-		"create pull requests up to the current branch")
+		"create pull requests up to the current branch",
+	)
 	_ = prCmd.Flags().MarkHidden("current")
 
 	deprecatedCreateCmd := deprecateCommand(*prCmd, "av pr", "create")
diff --git a/cmd/av/reorder.go b/cmd/av/reorder.go
@@ -50,7 +50,8 @@ squashed, dropped, or moved within the stack.
 		var continuation reorder.Continuation
 		if err := repo.ReadStateFile(git.StateFileKindReorder, &continuation); os.IsNotExist(err) {
 			if reorderFlags.Continue || reorderFlags.Abort {
-				fmt.Fprint(os.Stderr,
+				fmt.Fprint(
+					os.Stderr,
 					colors.Failure("ERROR: no reorder in progress\n"),
 				)
 				return actions.ErrExitSilently{ExitCode: 127}
@@ -90,7 +91,8 @@ squashed, dropped, or moved within the stack.
 			}
 			if stat != nil {
 				if err := repo.CherryPick(ctx, git.CherryPick{Resume: git.CherryPickContinue}); err != nil {
-					fmt.Fprint(os.Stderr,
+					fmt.Fprint(
+						os.Stderr,
 						colors.Failure("Failed to continue cherry-pick: ", err.Error(), "\n"),
 						colors.Warning("Resolve the conflict and run "),
 						colors.CliCmd("av reorder --continue"),
@@ -126,7 +128,8 @@ squashed, dropped, or moved within the stack.
 					return err
 				}
 				if currentHead == state.Head {
-					fmt.Fprint(os.Stderr,
+					fmt.Fprint(
+						os.Stderr,
 						colors.Failure("ERROR: cannot continue squash/fixup — the cherry-pick was not applied.\n"),
 						colors.Warning("If you aborted or skipped the cherry-pick, run "),
 						colors.CliCmd("av reorder --abort"),
@@ -137,7 +140,8 @@ squashed, dropped, or moved within the stack.
 
 				if err := pickCmd.PerformSquash(ctx, repo, state.BranchBase); err != nil {
 					if errors.Is(err, reorder.ErrEmptySquashMessage) {
-						fmt.Fprint(os.Stderr,
+						fmt.Fprint(
+							os.Stderr,
 							colors.Failure("squash commit message is empty after editing\n"),
 							colors.Warning("Edit the message and run "),
 							colors.CliCmd("av reorder --continue"),
@@ -165,7 +169,8 @@ squashed, dropped, or moved within the stack.
 			state.Head = head
 		} else {
 			if continuation.State != nil {
-				fmt.Fprint(os.Stderr,
+				fmt.Fprint(
+					os.Stderr,
 					colors.Failure("ERROR: reorder already in progress\n"),
 					colors.Failure("	   use --continue or --abort to continue or abort the reorder\n"),
 				)
@@ -178,7 +183,8 @@ squashed, dropped, or moved within the stack.
 			}
 			root, ok := meta.Root(tx, currentBranch)
 			if !ok {
-				fmt.Fprint(os.Stderr,
+				fmt.Fprint(
+					os.Stderr,
 					colors.Failure("ERROR: branch "), colors.UserInput(currentBranch),
 					colors.Failure(" is not part of a stack\n"),
 				)
@@ -215,7 +221,8 @@ squashed, dropped, or moved within the stack.
 			if err := repo.WriteStateFile(git.StateFileKindReorder, nil); err != nil {
 				return err
 			}
-			fmt.Fprint(os.Stderr,
+			fmt.Fprint(
+				os.Stderr,
 				colors.Success("\nThe stack was reordered successfully.\n"),
 			)
 			return nil
@@ -225,7 +232,8 @@ squashed, dropped, or moved within the stack.
 		if err := repo.WriteStateFile(git.StateFileKindReorder, &continuation); err != nil {
 			return err
 		}
-		fmt.Fprint(os.Stderr,
+		fmt.Fprint(
+			os.Stderr,
 			colors.Warning("\nThe reorder was interrupted by a conflict.\n"),
 			colors.Warning("Resolve the conflict and run "),
 			colors.CliCmd("av reorder --continue"),
@@ -255,7 +263,8 @@ edit:
 		return nil, err
 	}
 	if len(plan) == 0 {
-		fmt.Fprint(os.Stderr,
+		fmt.Fprint(
+			os.Stderr,
 			colors.Failure("ERROR: reorder plan is empty\n"),
 		)
 		return nil, actions.ErrExitSilently{ExitCode: 127}
diff --git a/cmd/av/stack_foreach.go b/cmd/av/stack_foreach.go
@@ -74,12 +74,14 @@ Examples:
 			}
 		}
 
-		_, _ = fmt.Fprint(os.Stderr,
+		_, _ = fmt.Fprint(
+			os.Stderr,
 			"Executing command ", colors.CliCmd(executils.FormatCommandLine(args)),
 			" for ", colors.UserInput(len(branches)), " branches:\n",
 		)
 		for _, branch := range branches {
-			_, _ = fmt.Fprint(os.Stderr,
+			_, _ = fmt.Fprint(
+				os.Stderr,
 				"  - switching to branch ", colors.UserInput(branch), "\n",
 			)
 			if _, err := repo.CheckoutBranch(ctx, &git.CheckoutBranch{Name: branch}); err != nil {
diff --git a/cmd/av/switch.go b/cmd/av/switch.go
@@ -66,7 +66,8 @@ var switchCmd = &cobra.Command{
 		for _, node := range rootNodes {
 			branchList = append(
 				branchList,
-				switchBranchList(ctx, repo, tx, branches, node)...)
+				switchBranchList(ctx, repo, tx, branches, node)...,
+			)
 		}
 		if len(branchList) == 0 {
 			return errors.New("no branches found")
diff --git a/cmd/av/sync.go b/cmd/av/sync.go
@@ -543,19 +543,22 @@ func init() {
 	syncCmd.MarkFlagsMutuallyExclusive("continue", "abort", "skip")
 
 	// Deprecated flags
-	syncCmd.Flags().Bool("no-fetch", false,
+	syncCmd.Flags().Bool(
+		"no-fetch", false,
 		"(deprecated; use av restack for offline restacking) do not fetch the latest status from GitHub",
 	)
 	_ = syncCmd.Flags().
 		MarkDeprecated("no-fetch", "please use av restack for offline restacking")
 
-	syncCmd.Flags().Bool("trunk", false,
+	syncCmd.Flags().Bool(
+		"trunk", false,
 		"(deprecated; use --rebase-to-trunk to rebase all branches to trunk) rebase the stack on the trunk branch",
 	)
 	_ = syncCmd.Flags().
 		MarkDeprecated("trunk", "please use --rebase-to-trunk to rebase all branches to trunk")
 
-	syncCmd.Flags().String("parent", "",
+	syncCmd.Flags().String(
+		"parent", "",
 		"(deprecated; use 'av adopt' or 'av reparent') parent branch to rebase onto",
 	)
 	_ = syncCmd.Flags().
diff --git a/docs/internal/md2man/md2man.go b/docs/internal/md2man/md2man.go
@@ -10,7 +10,8 @@ var returns = regexp.MustCompile(`\n+`)
 
 func RenderToRoff(text []byte, section int, version, source, volume string) []byte {
 	renderer := NewRoffRenderer(section, version, source, volume)
-	bs := blackfriday.Run(text,
+	bs := blackfriday.Run(
+		text,
 		[]blackfriday.Option{
 			blackfriday.WithRenderer(renderer),
 			blackfriday.WithExtensions(renderer.GetExtensions()),
diff --git a/internal/actions/pr.go b/internal/actions/pr.go
@@ -157,14 +157,16 @@ func CreatePullRequest(
 		var err error
 		existingPR, err = getExistingOpenPR(ctx, client, repoMeta, branchMeta, opts.BranchName)
 		if closed, ok := errutils.As[errPullRequestClosed](err); ok {
-			_, _ = fmt.Fprint(os.Stderr,
+			_, _ = fmt.Fprint(
+				os.Stderr,
 				colors.Failure("Existing pull request for branch "),
 				colors.UserInput(opts.BranchName),
 				colors.Failure(" is "), colors.UserInput(closed.State),
 				colors.Failure(": "), colors.UserInput(closed.Permalink),
 				"\n",
 			)
-			_, _ = fmt.Fprint(os.Stderr,
+			_, _ = fmt.Fprint(
+				os.Stderr,
 				colors.Faint("  - use "), colors.CliCmd("av pr --force"),
 				colors.Faint(" to create a new pull request for this branch\n"),
 			)
@@ -183,7 +185,8 @@ func CreatePullRequest(
 	if existingPR != nil {
 		verb = "Updating"
 	}
-	_, _ = fmt.Fprint(os.Stderr,
+	_, _ = fmt.Fprint(
+		os.Stderr,
 		verb, " pull request for branch ", colors.UserInput(opts.BranchName), ":",
 		"\n",
 	)
@@ -203,7 +206,8 @@ func CreatePullRequest(
 		pushFlags = append(pushFlags, remote, opts.BranchName)
 		logrus.Debug("pushing latest changes")
 
-		_, _ = fmt.Fprint(os.Stderr,
+		_, _ = fmt.Fprint(
+			os.Stderr,
 			"  - pushing to ", color.CyanString("%s/%s", remote, opts.BranchName),
 			"\n",
 		)
@@ -220,7 +224,8 @@ func CreatePullRequest(
 			return nil, err
 		}
 	} else {
-		_, _ = fmt.Fprint(os.Stderr,
+		_, _ = fmt.Fprint(
+			os.Stderr,
 			"  - skipping push to GitHub",
 			"\n",
 		)
@@ -403,7 +408,8 @@ func CreatePullRequest(
 		existingPR:  existingPR,
 	})
 	if err != nil {
-		_, _ = fmt.Fprint(os.Stderr,
+		_, _ = fmt.Fprint(
+			os.Stderr,
 			colors.Failure("  - failed to create pull request: "), err, "\n",
 		)
 		return nil, errors.WrapIf(err, "failed to create PR")
@@ -422,7 +428,8 @@ func CreatePullRequest(
 	} else {
 		action = "synchronized"
 	}
-	_, _ = fmt.Fprint(os.Stderr,
+	_, _ = fmt.Fprint(
+		os.Stderr,
 		"  - ", action, " pull request ",
 		colors.UserInput(pull.Permalink), "\n",
 	)
@@ -437,7 +444,8 @@ func CreatePullRequest(
 
 func OpenPullRequestInBrowser(ctx context.Context, pullRequestLink string) {
 	if err := browser.Open(ctx, pullRequestLink); err != nil {
-		_, _ = fmt.Fprint(os.Stderr,
+		_, _ = fmt.Fprint(
+			os.Stderr,
 			"  - couldn't open browser ",
 			colors.UserInput(err),
 			" for pull request link ",
@@ -452,7 +460,8 @@ func savePRDescriptionToTemporaryFile(saveFile string, contents string) {
 			Error("failed to write pull request description to temporary file")
 		return
 	}
-	_, _ = fmt.Fprint(os.Stderr,
+	_, _ = fmt.Fprint(
+		os.Stderr,
 		"  - saved pull request description to ", colors.UserInput(saveFile),
 		" (it will be automatically re-used if you try again)\n",
 	)
@@ -535,11 +544,10 @@ func ensurePR(
 
 	if opts.existingPR != nil {
 		newBody := AddPRMetadataAndStack(opts.body, opts.meta, opts.headRefName, initialStack, tx)
-		updatedPR, err := client.UpdatePullRequest(ctx, githubv4.UpdatePullRequestInput{
-			PullRequestID: opts.existingPR.ID,
-			Title:         gh.Ptr(githubv4.String(opts.title)),
-			Body:          gh.Ptr(githubv4.String(newBody)),
-			BaseRefName:   gh.Ptr(githubv4.String(opts.baseRefName)),
+		updatedPR, err := client.UpdatePullRequestIfChanged(ctx, opts.existingPR, gh.UpdatePullRequestFields{
+			Title:       gh.Ptr(opts.title),
+			Body:        gh.Ptr(newBody),
+			BaseRefName: gh.Ptr(opts.baseRefName),
 		})
 		if err != nil {
 			return nil, false, errors.WithStack(err)
@@ -950,11 +958,9 @@ func UpdatePullRequestWithStack(
 	}
 
 	newBody := AddPRMetadataAndStack(body, prMeta, branchName, stackToWrite, tx)
-	_, err = client.UpdatePullRequest(ctx, githubv4.UpdatePullRequestInput{
-		PullRequestID: existingPR.ID,
-		Body:          gh.Ptr(githubv4.String(newBody)),
-	})
-	if err != nil {
+	if _, err := client.UpdatePullRequestIfChanged(ctx, existingPR, gh.UpdatePullRequestFields{
+		Body: gh.Ptr(newBody),
+	}); err != nil {
 		return errors.WithStack(err)
 	}
 
diff --git a/internal/actions/reviewers.go b/internal/actions/reviewers.go
@@ -21,7 +21,8 @@ func AddPullRequestReviewers(
 	prID githubv4.ID,
 	reviewers []string,
 ) error {
-	_, _ = fmt.Fprint(os.Stderr,
+	_, _ = fmt.Fprint(
+		os.Stderr,
 		"  - adding ", colors.UserInput(len(reviewers)), " reviewer(s) to pull request\n",
 	)
 
diff --git a/internal/gh/ghui/push.go b/internal/gh/ghui/push.go
diff --git a/internal/gh/pullrequest.go b/internal/gh/pullrequest.go
diff --git a/internal/git/git.go b/internal/git/git.go
diff --git a/internal/git/gittest/repo.go b/internal/git/gittest/repo.go
diff --git a/internal/reorder/deletebranch.go b/internal/reorder/deletebranch.go

Original file line number	Diff line number	Diff line change
`@@ -44,7 +44,8 @@ func checkAviatorAuthStatus(ctx context.Context) error {`
`44`	`44`	`return errors.Wrap(err, "Failed to query Aviator")`
`45`	`45`	`}`
`46`	`46`
`47`		`- fmt.Fprint(os.Stderr,`
	`47`	`+ fmt.Fprint(`
	`48`	`+ os.Stderr,`
`48`	`49`	`"Logged in to Aviator as ", colors.UserInput(query.Viewer.FullName),`
`49`	`50`	`" (", colors.UserInput(query.Viewer.Email), ").\n",`
`50`	`51`	`)`
`@@ -69,7 +70,8 @@ func checkGitHubAuthStatus(ctx context.Context) error {`
`69`	`70`	`return errors.Wrap(err, "Failed to query GitHub")`
`70`	`71`	`}`
`71`	`72`
`72`		`- fmt.Fprint(os.Stderr,`
	`73`	`+ fmt.Fprint(`
	`74`	`+ os.Stderr,`
`73`	`75`	`"Logged in to GitHub as ", colors.UserInput(viewer.Name),`
`74`	`76`	`" (", colors.UserInput(viewer.Login), ").\n",`
`75`	`77`	`)`
Original file line number	Diff line number	Diff line change
`@@ -419,7 +419,8 @@ func init() {`
`419`	`419`	`)`
`420`	`420`	`prCmd.Flags().BoolVar(`
`421`	`421`	`&prFlags.Current, "current", false,`
`422`		`- "create pull requests up to the current branch")`
	`422`	`+ "create pull requests up to the current branch",`
	`423`	`+ )`
`423`	`424`	`_ = prCmd.Flags().MarkHidden("current")`
`424`	`425`
`425`	`426`	`deprecatedCreateCmd := deprecateCommand(*prCmd, "av pr", "create")`
Original file line number	Diff line number	Diff line change
`@@ -74,12 +74,14 @@ Examples:`
`74`	`74`	`}`
`75`	`75`	`}`
`76`	`76`
`77`		`- _, _ = fmt.Fprint(os.Stderr,`
	`77`	`+ _, _ = fmt.Fprint(`
	`78`	`+ os.Stderr,`
`78`	`79`	`"Executing command ", colors.CliCmd(executils.FormatCommandLine(args)),`
`79`	`80`	`" for ", colors.UserInput(len(branches)), " branches:\n",`
`80`	`81`	`)`
`81`	`82`	`for _, branch := range branches {`
`82`		`- _, _ = fmt.Fprint(os.Stderr,`
	`83`	`+ _, _ = fmt.Fprint(`
	`84`	`+ os.Stderr,`
`83`	`85`	`" - switching to branch ", colors.UserInput(branch), "\n",`
`84`	`86`	`)`
`85`	`87`	`if _, err := repo.CheckoutBranch(ctx, &git.CheckoutBranch{Name: branch}); err != nil {`