nprasad2077/docs

1 Fork 0

mirror of https://gitea.com/gitea/docs.git synced 2026-11-05 17:45:46 +00:00

Files

T

bircni 55c3a392a1 feat: generate the gt command reference from gitea/cli

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]>

2026-10-22 11:28:15 +02:00

4.2 KiB

Raw Blame History

sidebar_position, description

sidebar_position	description
14	Review a pull request or manage its reviews

gt pr review

Review a pull request or manage its reviews

Synopsis

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

4.2 KiB Raw Blame History