Skip to content
This repository has been archived by the owner on Nov 12, 2024. It is now read-only.

Commit

Permalink
docs: upstream
Browse files Browse the repository at this point in the history 
planetscale/www@2eb6334
  • Loading branch information
@planetscale-actions-bot
planetscale-actions-bot committed Oct 27, 2023
1 parent 03d56a9 commit 79aa91e
Showing 1 changed file with 23 additions and 23 deletions.
46 changes: 23 additions & 23 deletions docs/reference/deploy-request.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,20 +26,20 @@ Your database must have a production branch with [safe migrations](/docs/concept

### Available sub-commands

| **Sub-command** | **Sub-command flags** | **Description** |
| ----------------------------------------- | ---------------------------------------------------------------------------- | ----------------------------------------------- | ------------------------------------ |
| `apply <DATABASE_NAME> <DR_NUMBER>` | | Apply changes to a gated deploy request. |
| `cancel <DATABASE_NAME> <DR_NUMBER>` | | Cancel a deploy request. |
| `close <DATABASE_NAME> <DR_NUMBER>` | | Close the specified deploy request. |
| `create <DATABASE_NAME> <BRANCH_NAME>` | `--into <BRANCH_NAME>`, `--notes <NOTE>` | Create a new deploy request. |
| `deploy <DATABASE_NAME> <DR_NUMBER | BRANCH_NAME>` | | Deploy the specified deploy request. |
| `diff <DATABASE_NAME> <DR_NUMBER>` | `--web` | Show the diff of the specified deploy request. |
| `edit <DATABASE_NAME> <DR_NUMBER>` | `--auto-apply string` Possible values: [enable, disable] (default: "enable") | Edit a deploy request. |
| `list <DATABASE_NAME>` | `--web` | List all deploy requests for a database. |
| `revert <DATABASE_NAME> <DR_NUMBER>` | | Revert a deployed deploy request. |
| `review <DATABASE_NAME> <DR_NUMBER>` | `--web`, `--approve`, `--comment <COMMENT>` | Approve or comment on a deploy request. |
| `show <DATABASE_NAME> <DR_NUMBER | BRANCH_NAME>` | `--web` | Show the specified deploy request. |
| `skip-revert <DATABASE_NAME> <DR_NUMBER>` | | Skip and close a pending deploy request revert. |
| Sub-command | Sub-command flags | Description |
| ------------------------------------------------- | -------------------------------------------------------------------------- | ----------------------------------------------- |
| `apply <DATABASE_NAME> <DR_NUMBER>` | | Apply changes to a gated deploy request. |
| `cancel <DATABASE_NAME> <DR_NUMBER>` | | Cancel a deploy request. |
| `close <DATABASE_NAME> <DR_NUMBER>` | | Close the specified deploy request. |
| `create <DATABASE_NAME> <BRANCH_NAME>` | `--into <BRANCH_NAME>`, `--notes <NOTE>` | Create a new deploy request. |
| `deploy <DATABASE_NAME> <DR_NUMBER\|BRANCH_NAME>` | | Deploy the specified deploy request. |
| `diff <DATABASE_NAME> <DR_NUMBER>` | `--web` | Show the diff of the specified deploy request. |
| `edit <DATABASE_NAME> <DR_NUMBER>` | `--auto-apply string` Possible values: enable, disable (default: "enable") | Edit a deploy request. |
| `list <DATABASE_NAME>` | `--web` | List all deploy requests for a database. |
| `revert <DATABASE_NAME> <DR_NUMBER>` | | Revert a deployed deploy request. |
| `review <DATABASE_NAME> <DR_NUMBER>` | `--web`, `--approve`, `--comment <COMMENT>` | Approve or comment on a deploy request. |
| `show <DATABASE_NAME> <DR_NUMBER\|BRANCH_NAME>` | `--web` | Show the specified deploy request. |
| `skip-revert <DATABASE_NAME> <DR_NUMBER>` | | Skip and close a pending deploy request revert. |

> \* _Flag is required_
Expand All @@ -51,24 +51,24 @@ You can also find the number in the PlanetScale dashboard in the URL of the spec

Some of the sub-commands have additional flags unique to the sub-command. This section covers what each of those does. See the above table for which context.

| **Sub-command flag** | **Description** | **Applicable sub-commands** |
| ---------------------- | ------------------------------------------------------------------------------------ | --------------------------- |
| `--into <BRANCH_NAME>` | Specify that the new deploy request deploy to a specified branch. Default is `main`. | `create` |
| `--notes <NOTE>` | A note describing the deploy request. Acts as the first comment. | `create` |
| `--web` | Perform the action in your web browser | `diff`, `list`, `show` |
| `--approve` | Approve a deploy request | `review` |
| `--comment <COMMENT>` | Leave a comment on a deploy request | `review` |
| Sub-command flag | Description | Applicable sub-commands |
| ---------------------- | ------------------------------------------------------------------------------------ | ----------------------- |
| `--into <BRANCH_NAME>` | Specify that the new deploy request deploy to a specified branch. Default is `main`. | `create` |
| `--notes <NOTE>` | A note describing the deploy request. Acts as the first comment. | `create` |
| `--web` | Perform the action in your web browser | `diff`, `list`, `show` |
| `--approve` | Approve a deploy request | `review` |
| `--comment <COMMENT>` | Leave a comment on a deploy request | `review` |

### Available flags

| **Flag** | **Description** |
| Flag | Description |
| --------------------------- | ------------------------------------------------------------------ |
| `--h` | Get help with the `deploy-request` command |
| `--org <ORGANIZATION_NAME>` | Specify the organization for the deploy request you're acting upon |

### Global flags

| **Command** | **Description** |
| Command | Description |
| ------------------------------- | ------------------------------------------------------------------------------------ |
| `--api-token <TOKEN>` | The API token to use for authenticating against the PlanetScale API. |
| `--api-url <URL>` | The base URL for the PlanetScale API. Default is `https://api.planetscale.com/`. |
Expand Down

0 comments on commit 79aa91e

Please sign in to comment.