Skip to content

Commit cdfb82c

Browse files
committed
chore: spring cleaning of deploy CLI docs
1 parent 9ab9fb9 commit cdfb82c

File tree

1 file changed

+28
-22
lines changed

1 file changed

+28
-22
lines changed

src/views/docs/en/reference/cli/deploy.md

Lines changed: 28 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -8,34 +8,34 @@ sections:
88
- Flags
99
---
1010

11-
Deploy an Architect project to AWS by creating or updating a [CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html) stack with resources declared in [the project manifest](../../get-started/project-manifest).
11+
Deploy an Architect project to AWS by creating or updating a [CloudFormation][cfn] Stack with resources declared in [the project manifest][manifest].
1212

13-
CloudFormation stack names are created from the name specified in the `@app` pragma and are unique to an AWS region. Changing the project name or region will create a new CF stack.
13+
[CloudFormation][cfn] Stack names are created from the name specified in [the `@app` pragma][app] and are unique to an AWS region. Changing the project name or region will create a new [CloudFormation][cfn] Stack.
1414

1515
## Usage
1616

1717
```bash
18-
arc deploy [--production|--static|--direct]
18+
arc deploy [flags]
1919
```
2020

2121
## Flags
2222

23-
- `[--debug, -d]` Displays debug (and verbose) logging.
24-
- `[--direct path/to/function]` Overwrite staging Lambda with local source. A faster way to deploy and test small changes to individual functions without redeploying an entire stack.
25-
- `[--dry-run]` Creates a CloudFormation template but does not deploy it. A dry-run allows you to check the CloudFormation and SAM output before deploying the actual stack.
26-
- `[--fast, -f]` Deploy the stack, but do not hold the process open to determine whether the deployment succeeded or failed within AWS
27-
- `[--name, -n]` Deploy a custom named staging stack.
28-
- `[--no-hydrate]` Do not automatically run `npm`, `bundle`, or `pip`
29-
- `[--production, -p]` Deploys a CloudFormation stack to a production stack.
30-
- `[--prune]` Remove assets not present in the local static folder.
31-
- `[--static, -s]` Deploys only the files in the static folder.
32-
- `[--tags, -t]` Adds resource tags to the CloudFormation stack.
33-
- The required tag format is `key=value`, e.g. `--tags key1=value1 key2=value2`
34-
- `[--verbose, -v]` Displays verbose logging.
23+
- `--direct path/to/function`: Directly deploy the specified Lambda. A faster way to deploy and test small changes to individual functions without redeploying an entire Stack.
24+
- `--dry-run`: Generate a [CloudFormation][cfn] template but do not deploy it. A dry run allows you to check the [CloudFormation][cfn] and SAM output before deploying the actual stack.
25+
- `--eject`: Generate a [CloudFormation][cfn] template but do not deploy it. Instead, print out the `aws cloudformation` CLI invocation to execute the deployment.
26+
- `-f`, `--fast`: Deploy the stack, but do not block the process until deployment completed.
27+
- `-n`, `--name`: Deploy a custom named staging Stack. E.g. `--name CI` will deploy a `AppnameStagingCI` [CloudFormation][cfn] Stack.
28+
- `--no-hydrate`: Do not automatically [`hydrate`](hydrate) functions prior to deployment.
29+
- `-p`, `--production`: Deploys a [CloudFormation][cfn] Stack to a production Stack. If not specified, will default to deploy to a staging Stack.
30+
- `--prune`: Remove static assets deployed to S3 bucket not present in the local [`@static`][static] folder.
31+
- `-s`, `--static`: Deploys only the files in the [`@static`][static] folder.
32+
- `-t`, `--tags`: Adds resource tags to the CloudFormation stack. The required tag format is `key=value`, e.g. `--tags key1=value1 key2=value2`
33+
- `-v`, `--verbose`: Displays verbose logging.
34+
- `-d`, `--debug`: Displays debug (and verbose) logging.
3535

3636
## Local preferences: `@create`
3737

38-
When deploying, Architect can automatically scaffold resources (via [`arc init`](./init)) found in the [application's manifest](../../get-started/project-manifest) that do not yet exist. Options are set with [`@create` in local preferences](../configuration/local-preferences#%40create).
38+
When deploying, Architect can automatically scaffold resources (via [`init`](init)) found in the [application's manifest][manifest] that do not yet exist. Options are set with [`@create` in local preferences](../configuration/local-preferences#%40create).
3939

4040
- `autocreate` - Set to `true` to enable automatic creation of boilerplate Lambda handlers and static assets if they do not exist.
4141
- `templates` - Specify templates for automatic resource scaffolding.
@@ -52,42 +52,48 @@ templates
5252

5353
## Examples
5454

55-
### Deploy a staging stack
55+
### Deploy a staging Stack
5656

5757
```bash
5858
arc deploy
5959
```
6060

61-
### Deploy a production stack
61+
### Deploy a production Stack
6262

6363
```bash
6464
arc deploy --production
6565
```
6666

67-
### Deploy a named environment
67+
### Deploy a named staging Stack
6868

6969
```bash
7070
arc deploy --name my-stack
7171
```
7272

73-
> 💁 Named stacks use `staging` environment variables [set with `arc env -e staging --add`](./env).
73+
> 💁 Named stacks use `staging` environment variables [set with the `env` command](env).
7474
7575
### Deploy static assets to S3
7676

7777
```bash
7878
arc deploy --static
7979
```
8080

81-
### Deploy code directly to the staging Lambda
81+
### Deploy the index route directly to staging
8282

8383
```bash
8484
arc deploy --direct src/http/get-index
8585
```
8686

8787
### Run deploy without deploying
8888

89-
This is useful for testing `@macros`; it will still generate `sam.json`.
89+
This is useful for testing [`@plugins`][plugins]; it will still generate `sam.json`.
9090

9191
```bash
9292
arc deploy --dry-run
9393
```
94+
95+
[cfn]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html
96+
[manifest]: ../../get-started/project-manifest
97+
[static]: ../project-manifest/static
98+
[app]: ../project-manifest/app
99+
[plugins]: ../project-manifest/plugins

0 commit comments

Comments
 (0)