Jump to >

status-update

rbt status-update is used to interact with status-updates for review requests. There are three sub-commands for interacting with status-updates on review requests: get, set, delete.

Usage

$ rbt status-update [options] <action>

Getting status-updates

rbt status-update --review-request-id ID get is used for getting all status-updates associated with the review request specified or, if the --status-update-id option is specified, then only the status-update specified that is associated to the review request.

Setting status-updates

rbt status-update --review-request-id ID set is used for creating and updating status-updates. The --review option can be used to pass in a JSON formatted file with review details to attach a review to the status-update.

Deleting status-updates

rbt status-update --review-request-id ID --status-update-id ID delete is used for deleting status-updates.

--json is a flag for having the output of the command be formatted in JSON.

--review is for adding a review with the status-update. This option is for specifying a file describing the review and comments for the review. An example of the contents for the file:

{
    "review": {
        "body_top": "Header comment"
    },
    "diff_comments": [
        {
            "filediff_id": 1,
            "first_line": 1,
            "issue_opened": true,
            "num_lines": 1,
            "text": "Adding a comment on a diff line",
            "text_type": "markdown"
        },
        {
            "filediff_id": 2,
            "first_line": 2,
            "issue_opened": true,
            "num_lines": 1,
            "text": "Adding a second diff comment",
            "text_type": "markdown"
        }
    ],
    "general_comments": [
        {
            "text": "Adding a general comment",
            "text_type": "markdown"
        }
    ]
}

Options

-d, --debug

Displays debug output.

This information can be valuable when debugging problems running the command.

The default can be set in DEBUG in .reviewboardrc.

Status Update Options

Controls the behavior of a status-update, including what review request the status update is attached to.

-r <id>, --review-request-id <id>

Specifies which review request.

-s <id>, --status-update-id <id>

Specifies which status update from the review request.

-j, --json

Format command output in JSON.

--review <file path>

JSON formatted file defining details of review(s) to add to status update.

--change-id <id>

The change to a review request which this status update applies to. When not specified, the status update is for the review request as initially published.

--description <text>

A user-visible description of the status update.

--service-id <service id>

A unique identifier for the service providing the status update.

--state <state>

The current state of the status update.

--summary <text>

A user-visible short summary of the status update.

--timeout <timeout>

Timeout for pending status updates, measured in seconds.

--url <url>

URL to link to for more details about the status update.

--url-text <url text>

The text to use for the --url link.

Review Board Server Options

Options necessary to communicate and authenticate with a Review Board server.

--server <url>

Specifies the Review Board server to use.

The default can be set in REVIEWBOARD_URL in .reviewboardrc.

--username <username>

The user name to be supplied to the Review Board server.

The default can be set in USERNAME in .reviewboardrc.

--password <password>

The password to be supplied to the Review Board server.

The default can be set in PASSWORD in .reviewboardrc.

--ext-auth-cookies <ext auth cookies>

Use an external cookie store with pre-fetched authentication data. This is useful with servers that require extra web authentication to access Review Board, e.g. on single sign-on enabled sites.

The default can be set in EXT_AUTH_COOKIES in .reviewboardrc.

New in version 0.7.5.

--api-token <token>

The API token to use for authentication, instead of using a username and password.

The default can be set in API_TOKEN in .reviewboardrc.

New in version 0.7.

--disable-proxy

Prevents requests from going through a proxy server.

The default can be set in ENABLE_PROXY in .reviewboardrc.

--disable-ssl-verification

Disable SSL certificate verification. This is useful with servers that have self-signed certificates.

The default can be set in DISABLE_SSL_VERIFICATION in .reviewboardrc.

New in version 0.7.3.

Use an in-memory cookie store instead of writing them to a file. No credentials will be saved or loaded.

The default can be set in SAVE_COOKIES in .reviewboardrc.

New in version 0.7.3.

--disable-cache

Disable the HTTP cache completely. This will result in slower requests.

The default can be set in DISABLE_CACHE in .reviewboardrc.

New in version 0.7.3.

--disable-cache-storage

Disable storing the API cache on the filesystem, instead keeping it in memory temporarily.

The default can be set in IN_MEMORY_CACHE in .reviewboardrc.

New in version 0.7.3.

--cache-location <file>

The file to use for the API cache database.

The default can be set in CACHE_LOCATION in .reviewboardrc.

New in version 0.7.3.