Add pr update command

api/queries_pr.go

@@ -607,6 +607,18 @@ func UpdatePullRequestReviews(client *Client, repo ghrepo.Interface, params gith
  return err
 }
 
+func UpdatePullRequestBranch(client *Client, repo ghrepo.Interface, params githubv4.UpdatePullRequestBranchInput) error {
+ var mutation struct {
+ UpdatePullRequestBranch struct {
+ PullRequest struct {
+ ID string
+ }
+ } `graphql:"updatePullRequestBranch(input: $input)"`
+ }
+ variables := map[string]interface{}{"input": params}
+ return client.Mutate(repo.RepoHost(), "PullRequestUpdateBranch", &mutation, variables)
+}
+
 func isBlank(v interface{}) bool {
  switch vv := v.(type) {
  case string:
@@ -696,3 +708,44 @@ func BranchDeleteRemote(client *Client, repo ghrepo.Interface, branch string) er
  path := fmt.Sprintf("repos/%s/%s/git/refs/heads/%s", repo.RepoOwner(), repo.RepoName(), url.PathEscape(branch))
  return client.REST(repo.RepoHost(), "DELETE", path, nil, nil)
 }
+
+type RefComparison struct {
+ AheadBy int
+ BehindBy int
+ Status string
+}
+
+func ComparePullRequestBaseBranchWith(client *Client, repo ghrepo.Interface, prNumber int, headRef string) (*RefComparison, error) {
+ query := `query ComparePullRequestBaseBranchWith($owner: String!, $repo: String!, $pullRequestNumber: Int!, $headRef: String!) {
+ repository(owner: $owner, name: $repo) {
+ pullRequest(number: $pullRequestNumber) {
+ baseRef {
+ compare (headRef: $headRef) {
+ aheadBy, behindBy, status
+ }
+ }
+ }
+ }
+ }`
+
+ var result struct {
+ Repository struct {
+ PullRequest struct {
+ BaseRef struct {
+ Compare RefComparison
+ }
+ }
+ }
+ }
+ variables := map[string]interface{}{
+ "owner": repo.RepoOwner(),
+ "repo": repo.RepoName(),
+ "pullRequestNumber": prNumber,
+ "headRef": headRef,
+ }
+
+ if err := client.GraphQL(repo.RepoHost(), query, variables, &result); err != nil {
+ return nil, err
+ }
+ return &result.Repository.PullRequest.BaseRef.Compare, nil
+}

go.mod

@@ -36,7 +36,7 @@ require (
  github.com/muhammadmuzzammil1998/jsonc v0.0.0-20201229145248-615b0916ca38
  github.com/opentracing/opentracing-go v1.2.0
  github.com/rivo/tview v0.0.0-20221029100920-c4a7e501810d
- github.com/shurcooL/githubv4 v0.0.0-20230704064427-599ae7bbf278
+ github.com/shurcooL/githubv4 v0.0.0-20240120211514-18a1ae0e79dc
  github.com/sigstore/protobuf-specs v0.3.1
  github.com/sigstore/sigstore-go v0.3.0
  github.com/spf13/cobra v1.8.0

go.sum

@@ -380,8 +380,8 @@ github.com/sergi/go-diff v1.3.1 h1:xkr+Oxo4BOQKmkn/B9eMK0g5Kg/983T9DqqPHwYqD+8=
 github.com/sergi/go-diff v1.3.1/go.mod h1:aMJSSKb2lpPvRNec0+w3fl7LP9IOFzdc9Pa4NFbPK1I=
 github.com/shibumi/go-pathspec v1.3.0 h1:QUyMZhFo0Md5B8zV8x2tesohbb5kfbpTi9rBnKh5dkI=
 github.com/shibumi/go-pathspec v1.3.0/go.mod h1:Xutfslp817l2I1cZvgcfeMQJG5QnU2lh5tVaaMCl3jE=
-github.com/shurcooL/githubv4 v0.0.0-20230704064427-599ae7bbf278 h1:kdEGVAV4sO46DPtb8k793jiecUEhaX9ixoIBt41HEGU=
-github.com/shurcooL/githubv4 v0.0.0-20230704064427-599ae7bbf278/go.mod h1:zqMwyHmnN/eDOZOdiTohqIUKUrTFX62PNlu7IJdu0q8=
+github.com/shurcooL/githubv4 v0.0.0-20240120211514-18a1ae0e79dc h1:vH0NQbIDk+mJLvBliNGfcQgUmhlniWBDXC79oRxfZA0=
+github.com/shurcooL/githubv4 v0.0.0-20240120211514-18a1ae0e79dc/go.mod h1:zqMwyHmnN/eDOZOdiTohqIUKUrTFX62PNlu7IJdu0q8=
 github.com/shurcooL/graphql v0.0.0-20230722043721-ed46e5a46466 h1:17JxqqJY66GmZVHkmAsGEkcIu0oCe3AM420QDgGwZx0=
 github.com/shurcooL/graphql v0.0.0-20230722043721-ed46e5a46466/go.mod h1:9dIRpgIY7hVhoqfe0/FcYp0bpInZaT7dc3BYOprrIUE=
 github.com/sigstore/protobuf-specs v0.3.1 h1:9aJQrPq7iRDSLBNg//zsP7tAzxdHnD1sA+1FyCCrkrQ=

pkg/cmd/pr/pr.go

@@ -16,6 +16,7 @@ import (
  cmdReopen "github.com/cli/cli/v2/pkg/cmd/pr/reopen"
  cmdReview "github.com/cli/cli/v2/pkg/cmd/pr/review"
  cmdStatus "github.com/cli/cli/v2/pkg/cmd/pr/status"
+ cmdUpdate "github.com/cli/cli/v2/pkg/cmd/pr/update"
  cmdView "github.com/cli/cli/v2/pkg/cmd/pr/view"
  "github.com/cli/cli/v2/pkg/cmdutil"
  "github.com/spf13/cobra"
@@ -57,6 +58,7 @@ func NewCmdPR(f *cmdutil.Factory) *cobra.Command {
  cmdChecks.NewCmdChecks(f, nil),
  cmdReview.NewCmdReview(f, nil),
  cmdMerge.NewCmdMerge(f, nil),
+ cmdUpdate.NewCmdUpdate(f, nil),
  cmdReady.NewCmdReady(f, nil),
  cmdComment.NewCmdComment(f, nil),
  cmdClose.NewCmdClose(f, nil),

pkg/cmd/pr/update/update.go

@@ -0,0 +1,144 @@
+package update
+
+import (
+ "fmt"
+ "net/http"
+
+ "github.com/MakeNowJust/heredoc"
+ "github.com/cli/cli/v2/api"
+ "github.com/cli/cli/v2/git"
+ "github.com/cli/cli/v2/internal/ghrepo"
+ shared "github.com/cli/cli/v2/pkg/cmd/pr/shared"
+ "github.com/cli/cli/v2/pkg/cmdutil"
+ "github.com/cli/cli/v2/pkg/iostreams"
+ "github.com/shurcooL/githubv4"
+ "github.com/spf13/cobra"
+)
+
+type UpdateOptions struct {
+ HttpClient func() (*http.Client, error)
+ IO *iostreams.IOStreams
+ GitClient *git.Client
+
+ Finder shared.PRFinder
+
+ SelectorArg string
+ Rebase bool
+}
+
+func NewCmdUpdate(f *cmdutil.Factory, runF func(*UpdateOptions) error) *cobra.Command {
+ opts := &UpdateOptions{
+ IO: f.IOStreams,
+ HttpClient: f.HttpClient,
+ GitClient: f.GitClient,
+ }
+
+ cmd := &cobra.Command{
+ Use: "update [<number> | <url> | <branch>]",
+ Short: "Update a pull request branch",
+ Long: heredoc.Docf(`
+ Update a pull request branch with latest changes of the base branch.
+
+ Without an argument, the pull request that belongs to the current branch is selected.
+
+ The default behavior is to update with a merge commit (i.e., merging the base branch
+ into the the PR's branch). To reconcile the changes with rebasing on top of the base
+ branch, the %[1]s--rebase%[1]s option should be provided.
+ `, "`"),
+ Example: heredoc.Doc(`
+ $ gh pr update 23
+ $ gh pr update 23 --rebase
+ $ gh pr update 23 --repo owner/repo
+ `),
+ Args: cobra.MaximumNArgs(1),
+ RunE: func(cmd *cobra.Command, args []string) error {
+ opts.Finder = shared.NewFinder(f)
+
+ if repoOverride, _ := cmd.Flags().GetString("repo"); repoOverride != "" && len(args) == 0 {
+ return cmdutil.FlagErrorf("argument required when using the --repo flag")
+ }
+
+ if len(args) > 0 {
+ opts.SelectorArg = args[0]
+ }
+
+ if runF != nil {
+ return runF(opts)
+ }
+
+ return updateRun(opts)
+ },
+ }
+
+ cmd.Flags().BoolVar(&opts.Rebase, "rebase", false, "Update PR branch by rebasing on top of latest base branch")
+
+ _ = cmdutil.RegisterBranchCompletionFlags(f.GitClient, cmd, "base")
+
+ return cmd
+}
+
+func updateRun(opts *UpdateOptions) error {
+ findOptions := shared.FindOptions{
+ Selector: opts.SelectorArg,
+ Fields: []string{"id", "number", "headRefName", "headRefOid", "headRepositoryOwner"},
+ }
+
+ pr, repo, err := opts.Finder.Find(findOptions)
+ if err != nil {
+ return err
+ }
+
+ httpClient, err := opts.HttpClient()
+ if err != nil {
+ return err
+ }
+ apiClient := api.NewClientFromHTTP(httpClient)
+
+ headRef := pr.HeadRefName
+ if pr.HeadRepositoryOwner.Login != repo.RepoOwner() {
+ // Only prepend the `owner:` to comparison head ref if the PR head
+ // branch is on another repo (e.g., a fork).
+ headRef = pr.HeadRepositoryOwner.Login + ":" + headRef
+ }
+
+ opts.IO.StartProgressIndicator()
+ comparison, err := api.ComparePullRequestBaseBranchWith(apiClient, repo, pr.Number, headRef)
+ opts.IO.StopProgressIndicator()
+ if err != nil {
+ return err
+ }
+
+ cs := opts.IO.ColorScheme()
+ if comparison.BehindBy == 0 {
+ // The PR branch is not behind the base branch, so it'a already up-to-date.
+ fmt.Fprintf(opts.IO.ErrOut, "%s PR branch already up-to-date\n", cs.SuccessIcon())
+ return nil
+ }
+
+ opts.IO.StartProgressIndicator()
+ err = updatePullRequestBranch(apiClient, repo, pr.ID, pr.HeadRefOid, opts.Rebase)
+ opts.IO.StopProgressIndicator()
+ if err != nil {
+ return err
+ }
+
+ fmt.Fprintf(opts.IO.ErrOut, "%s PR branch updated\n", cs.SuccessIcon())
+ return nil
+}
+
+// updatePullRequestBranch calls the GraphQL API endpoint to update the given PR
+// branch with latest changes of its base.
+func updatePullRequestBranch(apiClient *api.Client, repo ghrepo.Interface, pullRequestID string, expectedHeadOid string, rebase bool) error {
+ updateMethod := githubv4.PullRequestBranchUpdateMethodMerge
+ if rebase {
+ updateMethod = githubv4.PullRequestBranchUpdateMethodRebase
+ }
+
+ params := githubv4.UpdatePullRequestBranchInput{
+ PullRequestID: pullRequestID,
+ ExpectedHeadOid: (*githubv4.GitObjectID)(&expectedHeadOid),
+ UpdateMethod: &updateMethod,
+ }
+
+ return api.UpdatePullRequestBranch(apiClient, repo, params)
+}