mirror of
https://gitea.com/gitea/docs.git
synced 2026-11-06 18:10:36 +00:00
bircni
55c3a392a1
update_cli_docs.sh runs gt's own generator and lays the pages out for the site: one directory per command group, front matter, titles, sidebar order, fenced help text and rewritten links. --released succeeds while no series is documented. A weekly workflow proposes updates like the runner's. Signed-off-by: bircni <[email protected]>
91 lines
4.2 KiB
Markdown
91 lines
4.2 KiB
Markdown
---
|
|
sidebar_position: 14
|
|
description: "Review a pull request or manage its reviews"
|
|
---
|
|
|
|
# gt pr review
|
|
|
|
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
|
|
|
Review a pull request or manage its reviews
|
|
|
|
## Synopsis
|
|
|
|
```text
|
|
Submit a review on a pull request, or manage existing reviews with the commands below.
|
|
|
|
Choose the review type with --approve, --request-changes or --comment. On a terminal, leaving
|
|
the type out opens an interactive review that also offers to annotate the diff in your editor.
|
|
|
|
Gitea adds a review to your pending review on the pull request, if you have one, which publishes
|
|
the pending review's inline comments; gt asks first, and without a terminal needs --yes. A body
|
|
you give replaces the pending review's body, which gt warns about; without one, it is kept.
|
|
```
|
|
|
|
```
|
|
gt pr review [<number> | <url> | <branch>] [flags]
|
|
```
|
|
|
|
## Examples
|
|
|
|
```
|
|
# Approve the pull request of the current branch
|
|
$ gt pr review --approve
|
|
|
|
# Request changes on #13
|
|
$ gt pr review 13 -r -b "Please hash the password"
|
|
|
|
# Start a pending review with inline comments, then submit it
|
|
$ gt pr review 13 --pending --comments-file inline.json
|
|
$ gt pr review submit 13 --approve
|
|
```
|
|
|
|
## Options
|
|
|
|
```
|
|
-a, --approve Approve the pull request
|
|
-b, --body string Review body
|
|
-F, --body-file file Read the body from file, or - for stdin
|
|
-c, --comment Comment without approving (requires a body or inline comments, which can be those of the pending review it publishes; an empty --body clears that review's body when it has inline comments, and is refused otherwise)
|
|
--comments-file file Read inline comments from a JSON file: an array of path, body, and new_position or old_position on a line of the diff
|
|
--commit sha Commit sha to review (default: the head of the pull request)
|
|
-e, --editor Write the body in your editor
|
|
-h, --help help for review
|
|
--pending Save the review as pending, to submit later with gt pr review submit
|
|
-r, --request-changes Request changes (requires a body)
|
|
```
|
|
|
|
## Options inherited from parent commands
|
|
|
|
```
|
|
--cwd directory Working directory for repository discovery
|
|
--debug Log the method, URL, status, and duration of each HTTP request to stderr
|
|
--host URL Gitea instance URL, including any base path
|
|
--interactive Allow prompts with machine output
|
|
-q, --jq expression Filter JSON output using a jq expression; implies --json
|
|
--json fields[="*"] Output JSON with the specified comma-separated fields, or all fields
|
|
--no-input Disable prompts and implicit editor/browser interactions
|
|
--remote remote Git remote used for repository discovery
|
|
-R, --repo OWNER/REPO Select a repository as OWNER/REPO or URL
|
|
--sudo user Perform API requests as this user (requires an administrator account)
|
|
--user name Account name on the selected instance
|
|
-y, --yes Accept confirmations without prompting
|
|
```
|
|
|
|
## SEE ALSO
|
|
|
|
* [gt pr](../../pr/index.md): Manage pull requests
|
|
* [gt pr review cancel-request](../../pr/review/cancel-request.md): Withdraw review requests
|
|
* [gt pr review comments](../../pr/review/comments.md): List inline review comments
|
|
* [gt pr review create](../../pr/review/create.md): Submit a review (same as "gt pr review")
|
|
* [gt pr review delete](../../pr/review/delete.md): Delete a review
|
|
* [gt pr review dismiss](../../pr/review/dismiss.md): Dismiss an approval or change request
|
|
* [gt pr review list](../../pr/review/list.md): List reviews on a pull request
|
|
* [gt pr review reply](../../pr/review/reply.md): Reply to an inline review comment
|
|
* [gt pr review request](../../pr/review/request.md): Request reviews from users or teams
|
|
* [gt pr review resolve](../../pr/review/resolve.md): Mark an inline conversation as resolved
|
|
* [gt pr review submit](../../pr/review/submit.md): Submit your pending review
|
|
* [gt pr review undismiss](../../pr/review/undismiss.md): Restore a dismissed review
|
|
* [gt pr review unresolve](../../pr/review/unresolve.md): Reopen a resolved inline conversation
|
|
* [gt pr review view](../../pr/review/view.md): View a review
|