feat: implement gh `pr revert` #8826

lucasmelin · 2024-03-17T03:43:29Z

Adds a new pr revert command that enables reverting a merged PR using the gh CLI.

Usage

# Revert a PR
$ gh pr revert 123

# Provide revert PR options
$ gh pr revert --draft --title 'Example title' --body 'Example body' 123

lucasmelin · 2024-03-17T13:06:39Z

Putting back into draft to add the revert PR details to the success message output.

lucasmelin · 2024-03-17T13:28:56Z

Added the revert PR details to the message output, ready for review.

Copilot

Pull Request Overview

This PR implements a new gh pr revert command that allows users to revert merged pull requests using the GitHub CLI. The feature supports customization of the revert PR with options for title, body, and draft status.

Adds core revert functionality with validation to ensure only merged PRs can be reverted
Includes comprehensive test coverage for successful reverts, error cases, and option handling
Integrates the new command into the existing PR command structure

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.

File	Description
pkg/cmd/pr/revert/revert.go	Core implementation of the revert command with options handling and API integration
pkg/cmd/pr/revert/revert_test.go	Comprehensive test suite covering success cases, error handling, and option validation
pkg/cmd/pr/pr.go	Integration of the revert command into the main PR command structure
api/queries_pr.go	GraphQL API function for executing pull request revert mutations

pkg/cmd/pr/revert/revert.go

api/queries_pr.go

BagToad · 2025-09-25T17:40:10Z

👋 Hi @lucasmelin! I just posted the Acceptance Criteria for this issue in #6034 (comment). I also added the help wanted label, so this is now ready for community contributions per our contributing guidelines 😁

It looks like there's some tests failing - please let me know if you're still interested in contributing to this! Please also let me know if you have any questions about the Acceptance Criteria or anything else 😃

cc @connor15mcc since you commented on the issue as well.

Also adds test cases for the new acceptance criteria.

BagToad

Hey @lucasmelin 👋 Doing some testing with this, and it's looking good! While testing, I noticed some type errors when we use the full PullRequest type:

❯ gh pr revert 75
X GraphQL: Field 'id' doesn't exist on type 'Actor' (mutation PullRequestRevert.revertPullRequest.revertPullRequest.autoMergeRequest.enabledBy.id), Field 'name' doesn't exist on type 'Actor' (mutation PullRequestRevert.revertPullRequest.revertPullRequest.autoMergeRequest.enabledBy.name), Field 'id' doesn't exist on type 'Actor' (mutation PullRequestRevert.revertPullRequest.revertPullRequest.author.id), Field 'name' doesn't exist on type 'Actor' (mutation PullRequestRevert.revertPullRequest.revertPullRequest.author.name), Field 'id' doesn't exist on type 'Actor' (mutation PullRequestRevert.revertPullRequest.revertPullRequest.mergedBy.id), Field 'name' doesn't exist on type 'Actor' (mutation PullRequestRevert.revertPullRequest.revertPullRequest.mergedBy.name), Field 'name' doesn't exist on type 'RepositoryOwner' (mutation PullRequestRevert.revertPullRequest.revertPullRequest.headRepositoryOwner.name), Field 'nodes' doesn't exist on type 'StatusCheckRollup' (mutation PullRequestRevert.revertPullRequest.revertPullRequest.statusCheckRollup.nodes), Selections can't be made directly on unions (see selections on Assignee) (mutation PullRequestRevert.revertPullRequest.revertPullRequest.assignedActors.nodes.id), Selections can't be made directly on unions (see selections on Assignee) (mutation PullRequestRevert.revertPullRequest.revertPullRequest.assignedActors.nodes.login), Selections can't be made directly on unions (see selections on Assignee) (mutation PullRequestRevert.revertPullRequest.revertPullRequest.assignedActors.nodes.name), Selections can't be made directly on unions (see selections on Assignee) (mutation PullRequestRevert.revertPullRequest.revertPullRequest.assignedActors.nodes.typeName), Field 'status' doesn't exist on type 'ProjectV2Item' (mutation PullRequestRevert.revertPullRequest.revertPullRequest.projectItems.nodes.status), Selections can't be made directly on unions (see selections on RequestedReviewer) (mutation PullRequestRevert.revertPullRequest.revertPullRequest.reviewRequests.nodes.requestedReviewer.typeName), Selections can't be made directly on unions (see selections on RequestedReviewer) (mutation PullRequestRevert.revertPullRequest.revertPullRequest.reviewRequests.nodes.requestedReviewer.login), Selections can't be made directly on unions (see selections on RequestedReviewer) (mutation PullRequestRevert.revertPullRequest.revertPullRequest.reviewRequests.nodes.requestedReviewer.name), Selections can't be made directly on unions (see selections on RequestedReviewer) (mutation PullRequestRevert.revertPullRequest.revertPullRequest.reviewRequests.nodes.requestedReviewer.slug), Selections can't be made directly on unions (see selections on RequestedReviewer) (mutation PullRequestRevert.revertPullRequest.revertPullRequest.reviewRequests.nodes.requestedReviewer.organization)
API call failed: GraphQL: Field 'id' doesn't exist on type 'Actor' (mutation PullRequestRevert.revertPullRequest.revertPullRequest.autoMergeRequest.enabledBy.id), Field 'name' doesn't exist on type 'Actor' (mutation PullRequestRevert.revertPullRequest.revertPullRequest.autoMergeRequest.enabledBy.name), Field 'id' doesn't exist on type 'Actor' (mutation PullRequestRevert.revertPullRequest.revertPullRequest.author.id), Field 'name' doesn't exist on type 'Actor' (mutation PullRequestRevert.revertPullRequest.revertPullRequest.author.name), Field 'id' doesn't exist on type 'Actor' (mutation PullRequestRevert.revertPullRequest.revertPullRequest.mergedBy.id), Field 'name' doesn't exist on type 'Actor' (mutation PullRequestRevert.revertPullRequest.revertPullRequest.mergedBy.name), Field 'name' doesn't exist on type 'RepositoryOwner' (mutation PullRequestRevert.revertPullRequest.revertPullRequest.headRepositoryOwner.name), Field 'nodes' doesn't exist on type 'StatusCheckRollup' (mutation PullRequestRevert.revertPullRequest.revertPullRequest.statusCheckRollup.nodes), Selections can't be made directly on unions (see selections on Assignee) (mutation PullRequestRevert.revertPullRequest.revertPullRequest.assignedActors.nodes.id), Selections can't be made directly on unions (see selections on Assignee) (mutation PullRequestRevert.revertPullRequest.revertPullRequest.assignedActors.nodes.login), Selections can't be made directly on unions (see selections on Assignee) (mutation PullRequestRevert.revertPullRequest.revertPullRequest.assignedActors.nodes.name), Selections can't be made directly on unions (see selections on Assignee) (mutation PullRequestRevert.revertPullRequest.revertPullRequest.assignedActors.nodes.typeName), Field 'status' doesn't exist on type 'ProjectV2Item' (mutation PullRequestRevert.revertPullRequest.revertPullRequest.projectItems.nodes.status), Selections can't be made directly on unions (see selections on RequestedReviewer) (mutation PullRequestRevert.revertPullRequest.revertPullRequest.reviewRequests.nodes.requestedReviewer.typeName), Selections can't be made directly on unions (see selections on RequestedReviewer) (mutation PullRequestRevert.revertPullRequest.revertPullRequest.reviewRequests.nodes.requestedReviewer.login), Selections can't be made directly on unions (see selections on RequestedReviewer) (mutation PullRequestRevert.revertPullRequest.revertPullRequest.reviewRequests.nodes.requestedReviewer.name), Selections can't be made directly on unions (see selections on RequestedReviewer) (mutation PullRequestRevert.revertPullRequest.revertPullRequest.reviewRequests.nodes.requestedReviewer.slug), Selections can't be made directly on unions (see selections on RequestedReviewer) (mutation PullRequestRevert.revertPullRequest.revertPullRequest.reviewRequests.nodes.requestedReviewer.organization)

To solve this, I think we should do something similar to what the create pull request mutation does and return just the basic pull request info. Here's a diff of the change I think we need:

diff --git a/api/queries_pr.go b/api/queries_pr.go
index c34c9a80c..0eb8441ed 100644
--- a/api/queries_pr.go
+++ b/api/queries_pr.go
@@ -770,7 +770,11 @@ func PullRequestRevert(client *Client, repo ghrepo.Interface, params githubv4.Re
 			PullRequest struct {
 				ID githubv4.ID
 			}
-			RevertPullRequest PullRequest
+			RevertPullRequest struct {
+				ID     string
+				Number int
+				URL    string
+			}
 		} `graphql:"revertPullRequest(input: $input)"`
 	}
 
@@ -781,7 +785,12 @@ func PullRequestRevert(client *Client, repo ghrepo.Interface, params githubv4.Re
 	if err != nil {
 		return nil, err
 	}
-	revertPR := &mutation.RevertPullRequest.RevertPullRequest
+	pr := &mutation.RevertPullRequest.RevertPullRequest
+	revertPR := &PullRequest{
+		ID:     pr.ID,
+		Number: pr.Number,
+		URL:    pr.URL,
+	}
 	return revertPR, nil
 }

What do you think?

Co-authored-by: Kynan Ware <[email protected]>

lucasmelin · 2025-10-22T22:05:03Z

@BagToad, makes sense. 👍🏻 Implemented your suggestion in the most recent commit.

BagToad

Thank you for your patience @lucasmelin 🙏

I've tested this and reviewed the code and it looks good to me 👍 Thank you for this contribution!

lucasmelin requested a review from a team as a code owner March 17, 2024 03:43

lucasmelin requested review from williammartin and removed request for a team March 17, 2024 03:43

cliAutomation added the external pull request originating outside of the CLI core team label Mar 17, 2024

lucasmelin marked this pull request as draft March 17, 2024 13:06

lucasmelin marked this pull request as ready for review March 17, 2024 13:28

Copilot AI review requested due to automatic review settings July 27, 2025 16:48

Copilot AI reviewed Jul 27, 2025

View reviewed changes

pkg/cmd/pr/revert/revert.go Show resolved Hide resolved

pkg/cmd/pr/revert/revert.go Show resolved Hide resolved

api/queries_pr.go Outdated Show resolved Hide resolved

BagToad mentioned this pull request Aug 18, 2025

Provide gh cli Support to Revert Pull Request #6034

Closed

lucasmelin requested review from a team as code owners October 6, 2025 16:58

lucasmelin added 7 commits October 6, 2025 13:25

feat: implement pr revert

60b6a5e

Undo autoformat changes

9467d66

feat: include revert PR info in message output

023a639

Fix revert unit tests by using renamed helper

5368f40

Return nil when err is nil

b229402

Adjust PR revert based on new acceptance criteria

4f10a52

Also adds test cases for the new acceptance criteria.

Address remaining PR comments for revert implementation

ef7ac8c

lucasmelin force-pushed the lucasmelin/add-pr-revert-command branch from 912fcfe to ef7ac8c Compare October 6, 2025 17:29

BagToad requested changes Oct 22, 2025

View reviewed changes

cmbrose removed the request for review from a team October 22, 2025 20:03

Return only basic pull request info when reverting a PR

6db1441

Co-authored-by: Kynan Ware <[email protected]>

lucasmelin force-pushed the lucasmelin/add-pr-revert-command branch from 941efb6 to 6db1441 Compare October 22, 2025 22:02

BagToad approved these changes Oct 23, 2025

View reviewed changes

BagToad merged commit b90e39e into cli:trunk Oct 23, 2025
11 checks passed

github-project-automation bot moved this to Done in VITA PRO MAX@MOSTAFAAMMER Oct 23, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

feat: implement gh `pr revert` #8826

feat: implement gh `pr revert` #8826

lucasmelin commented Mar 17, 2024

Uh oh!

lucasmelin commented Mar 17, 2024

Uh oh!

lucasmelin commented Mar 17, 2024

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

BagToad commented Sep 25, 2025

Uh oh!

BagToad left a comment

Uh oh!

lucasmelin commented Oct 22, 2025

Uh oh!

BagToad left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

feat: implement gh pr revert #8826

feat: implement gh pr revert #8826

Conversation

lucasmelin commented Mar 17, 2024

Usage

Uh oh!

lucasmelin commented Mar 17, 2024

Uh oh!

lucasmelin commented Mar 17, 2024

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

BagToad commented Sep 25, 2025

Uh oh!

BagToad left a comment

Choose a reason for hiding this comment

Uh oh!

lucasmelin commented Oct 22, 2025

Uh oh!

BagToad left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

feat: implement gh `pr revert` #8826

feat: implement gh `pr revert` #8826