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@d27d31a
  • Loading branch information
@planetscale-actions-bot
planetscale-actions-bot committed Aug 21, 2024
1 parent c4e8212 commit 66c010a
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions docs/reference/deploy-request.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Your database must have a production branch with [safe migrations](/docs/concept
| `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. |
| `deploy <DATABASE_NAME> <DR_NUMBER\|BRANCH_NAME>` | `--instant` | 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. |
Expand All @@ -51,13 +51,14 @@ 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` |
| `--instant` | Deploy a deploy request using MySQL’s built-in ALGORITHM=INSTANT option. Deployment will be faster, but cannot be reverted. | `deploy` |

### Available flags

Expand Down

0 comments on commit 66c010a

Please sign in to comment.