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.

Sign up for GitHub

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

Add deploy command doc #15402

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
76b7aa2
docs: add deploy command doc
jbogarthyde Aug 21, 2019
72b51db
docs: fix json example
jbogarthyde Aug 21, 2019
56d2e5b
docs: add link to cli builder doc
jbogarthyde Aug 21, 2019
fc213ec
docs: remove link
jbogarthyde Aug 21, 2019
4a30e76
docs: restore link
jbogarthyde Aug 22, 2019
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
37 changes: 33 additions & 4 deletions packages/angular/cli/commands/deploy-long.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,38 @@
The `ng deploy` command is a shortcut for:
The command is a shortcut for:

```
<code-example language="bash">
ng run [PROJECT_NAME]:deploy
```
</code-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, executes the `deploy` builder for the default project.

When a project name is not supplied, the CLI will execute the `deploy` builder for the default project.
The deploy builder defined in a deployment platform package is automatically added to a project's configuration when you add the package to the project.
Copy link
Member

Choose a reason for hiding this comment

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

Can we update it to something like:

To use the ng deploy command ng add a package that implements deployment capabilities to your favorite platform. The ng-add schematics of the package will automatically update your workspace configuration, adding a deployment 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.

Also adding link to CLI Builder guide.

For example:

```json
"projects": {
{"my-project": {
...
{"architect": {
...
"deploy": {
"builder": "@angular/fire:deploy",
"options": {}
}
}
}
}
}
}
```





}


}
}
2 changes: 1 addition & 1 deletion packages/angular/cli/commands/deploy.json
View file
Open in desktop
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