mirror of
https://gitea.com/gitea/docs.git
synced 2026-11-06 01:50:30 +00:00
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]>
This commit is contained in:
261 files changed
+15116
-2
No files matched your search
@@ -0,0 +1,84 @@
|
||||
---
|
||||
sidebar_position: 9
|
||||
description: "Edit a pull request"
|
||||
---
|
||||
|
||||
# gt pr edit
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Edit a pull request
|
||||
|
||||
## Synopsis
|
||||
|
||||
```text
|
||||
Edit the title, body, base branch, reviewers, labels, assignees, milestone or due date of a
|
||||
pull request, or mark it as a draft or ready for review.
|
||||
|
||||
Gitea changes the milestone, assignees and due date only for people who can write to the pull
|
||||
requests of the repository, and leaves them as they were for the author of a pull request who
|
||||
cannot: gt then names the flags it left out and fails. Gitea refuses their label changes
|
||||
outright, so gt sends the other changes first.
|
||||
```
|
||||
|
||||
```
|
||||
gt pr edit [<number> | <url> | <branch>] [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt pr edit 13 --title "Add login support" --add-reviewer carol
|
||||
$ gt pr edit --base develop
|
||||
$ gt pr edit 13 --editor
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
--add-assignee login Add assignees by login; @me for yourself
|
||||
--add-label name Add labels by name; prefix repo: or org: to disambiguate
|
||||
--add-project title Add the pull request to the project with this title (repeatable)
|
||||
--add-reviewer strings Request reviews from users; @me for yourself
|
||||
--add-reviewer-team strings Request reviews from teams of the repository's organization
|
||||
--allow-maintainer-edit Allow maintainers to push to the head branch
|
||||
-B, --base string Base branch
|
||||
-b, --body string Pull request body (empty clears)
|
||||
-F, --body-file file Read the body from file, or - for stdin
|
||||
--deadline date Due date: YYYY-MM-DD, RFC3339 or Unix timestamp; only the date counts, as the end of that day in UTC; empty clears it
|
||||
--draft Mark the pull request as a draft (same as gt pr ready --undo)
|
||||
-e, --editor Edit the current body in your editor
|
||||
-h, --help help for edit
|
||||
-m, --milestone string Milestone title or ID; 0 removes it
|
||||
--ready Mark the pull request as ready for review (same as gt pr ready)
|
||||
--remove-assignee login Remove assignees by login; @me for yourself
|
||||
--remove-label name Remove labels by name
|
||||
--remove-milestone Remove the milestone
|
||||
--remove-project title Take the pull request off the project with this title (repeatable)
|
||||
--remove-reviewer strings Withdraw review requests from users
|
||||
--remove-reviewer-team strings Withdraw review requests from teams
|
||||
--set-assignees strings Replace all assignees; an empty value clears them
|
||||
--set-labels strings Replace all labels; an empty value clears them
|
||||
-t, --title string Pull request title
|
||||
```
|
||||
|
||||
## 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
|
||||
Reference in new issue
Block a user