Skip to content

Commit

Permalink
Add deploy command doc (#15402)
Browse files Browse the repository at this point in the history
* docs: add deploy command doc

* docs: fix json example

* docs: add link to cli builder doc

* docs: remove link

* docs: restore link
  • Loading branch information
jbogarthyde authored and Keen Yee Liau committed Aug 22, 2019
1 parent 1a833ee commit 35313dc
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 8 deletions.
27 changes: 20 additions & 7 deletions packages/angular/cli/commands/deploy-long.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,22 @@
The `ng deploy` command is a shortcut for:
The command takes an optional project name, as specified in the `projects` section of the `angular.json` workspace configuration file.
When a project name is not supplied, executes the `deploy` builder for the default project.

```
ng run [PROJECT_NAME]:deploy
```
To use the `ng deploy` command, use `ng add` to add a package that implements deployment capabilities to your favorite platform.
Adding the package automatically updates your workspace configuration, adding a deployment
[CLI builder](guide/cli-builder).
For example:

It takes an optional project name, as specified in the `projects` section of the `angular.json` workspace configuration file.

When a project name is not supplied, the CLI will execute the `deploy` builder for the default project.
```json
"projects": {
"my-project": {
...
"architect": {
...
"deploy": {
"builder": "@angular/fire:deploy",
"options": {}
}
}
}
}
```
2 changes: 1 addition & 1 deletion packages/angular/cli/commands/deploy.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"$schema": "http://json-schema.org/schema",
"$id": "ng-cli://commands/deploy.json",
"description": "Invokes the deploy builder for a specified project. If no project is specified, the CLI will invoke the deploy builder for the default project in the workspace.",
"description": "Invokes the deploy builder for a specified project or for the default project in the workspace.",
"$longDescription": "./deploy-long.md",

"$aliases": [ "d" ],
Expand Down

0 comments on commit 35313dc

Please sign in to comment.