Skip to content

Commit

Permalink
fix: minor updates to the --help (#85)
Browse files Browse the repository at this point in the history
  • Loading branch information
jshackell-sfdc authored Jul 19, 2021
1 parent 1efdf7e commit a7cf8bd
Showing 1 changed file with 12 additions and 6 deletions.
18 changes: 12 additions & 6 deletions messages/deploy.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,30 @@
# summary

Deploy a project interactively to any Salesforce environment.

# description

The command first analyzes your project, active or logged-into environments, and local defaults to determine what to deploy and where. The command then prompts you for information about this particular deployment and provides intelligent choices based on its analysis.
This command must be run from within a project.

For example, if your local project contains a package directory with metadata source files, the command asks if you want to deploy that Salesforce app to an org. The command lists your connected orgs and asks which one you want to deploy to. If the command finds Apex tests, it asks if you want to run them and at which level.
The command first analyzes your project, your active or logged-into environments, and local defaults to determine what to deploy and where to deploy it. The command then prompts you for information about this particular deployment and provides intelligent choices based on its analysis.

Similarly, if the command finds a local functions directory, the command prompts if you want to deploy it and to which compute environment. The command prompts and connects you to a compute environment of your choice if you’re not currently connected to any.
For example, if your local project contains a source directory with metadata files in source format, the command asks if you want to deploy that Salesforce app to an org. The command lists your connected orgs and asks which one you want to deploy to. If the command finds Apex tests, it asks if you want to run them and at which level.

This command must be run from within a project.
Similarly, if the command finds a local functions directory, the command prompts if you want to deploy it and to which compute environment. The command prompts and connects you to a compute environment of your choice if you’re not currently connected to any.

The command stores your responses in a local file and uses them as defaults when you rerun the command. Specify --interactive to force the command to reprompt.

Use this command for quick and simple deploys. For more complicated deployments, use the environment-specific commands, such as "sf project deploy org", that provide additional flags.

# examples

- <%= config.bin %> <%= command.id %>
- Deploy a project and use stored values from a previous command run:

<%= config.bin %> <%= command.id %>

- Reprompt for all deployment inputs:

<%= config.bin %> <%= command.id %> --interactive

# flags.interactive.summary

Expand Down

0 comments on commit a7cf8bd

Please sign in to comment.