Skip to content

Add deploy command doc #15402

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Aug 22, 2019
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Users see deploy-long.md when the run ng deploy --help as well and this won't be rendered properly. Maybe we can drop it?

Suggested change
`CLI builder`(guide/cli-builder).
`CLI builder`.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK -- but I think the long description only shows up in AIO, not in the help.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep, feel free to ignore my comment.

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