mirror of
https://gitea.com/gitea/docs.git
synced 2026-11-05 17:45:46 +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]>
66 lines
2.2 KiB
Markdown
66 lines
2.2 KiB
Markdown
---
|
|
sidebar_position: 3
|
|
description: "Show the status checks of a pull request"
|
|
---
|
|
|
|
# gt pr checks
|
|
|
|
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
|
|
|
Show the status checks of a pull request
|
|
|
|
## Synopsis
|
|
|
|
```text
|
|
Show the latest status of each check of a pull request's head commit.
|
|
|
|
gt exits with 8 while checks are pending and with 1 when a check failed, like gh. With
|
|
--watch, it waits until every check finished, or one failed, and polls on through an outage of
|
|
the instance of up to 5 minutes.
|
|
```
|
|
|
|
```
|
|
gt pr checks [<number> | <url> | <branch>] [flags]
|
|
```
|
|
|
|
## Examples
|
|
|
|
```
|
|
# Show the checks of the current branch's pull request
|
|
$ gt pr checks
|
|
|
|
# Wait until the checks of #13 finish, then merge it
|
|
$ gt pr checks 13 --watch && gt pr merge 13
|
|
```
|
|
|
|
## Options
|
|
|
|
```
|
|
-h, --help help for checks
|
|
--interval duration Time between refreshes with --watch (default 5s)
|
|
--timeout duration Longest time to wait with --watch (default 1h0m0s)
|
|
--watch Wait for the checks to finish, stopping at the first failure
|
|
-w, --web Open the pull request in the browser
|
|
```
|
|
|
|
## 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
|