-
Notifications
You must be signed in to change notification settings - Fork 12k
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
Add deploy command doc #15402
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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": {} | ||
} | ||
jbogarthyde marked this conversation as resolved.
Show resolved
Hide resolved
|
||
} | ||
} | ||
} | ||
``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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 runng deploy --help
as well and this won't be rendered properly. Maybe we can drop it?There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.