prodlysfcli 1.0.1 → 1.2.0

package/README.md

@@ -62,6 +62,7 @@ FLAGS
   -o, --target-org=<value>      (required) Username or alias of the target org. Not
                                 required if the `target-org` configuration variable is already set.
   -p, --plan=<value>            name or record ID of the deployment plan to deploy
+  -q, --filter=<value>          query filter override for a data set deployment
   -t, --dataset=<value>         name or record ID of the data set to deploy
   -v, --target-dev-hub=<value>  (required) Username or alias of the Dev Hub org. Not
                                 required if the `target-dev-hub` configuration variable is already set.
@@ -73,7 +74,7 @@ GLOBAL FLAGS
 DESCRIPTION
   prodly:checkin command
 
-  Launches an Prodly relational data deployment.
+  Save data from a Salesforce environment to a VCS repository branch.
 
 EXAMPLES
   $ sf prodly:checkin --target-org test-utxac7gbati9@example.com --target-dev-hub jsmith@acme.com
@@ -104,6 +105,7 @@ FLAGS
   -o, --target-org=<value>      (required) Username or alias of the target org. Not
                                 required if the `target-org` configuration variable is already set.
   -p, --plan=<value>            name or record ID of the deployment plan to deploy
+  -q, --filter=<value>          query filter override for a data set deployment
   -t, --dataset=<value>         name or record ID of the data set to deploy
   -v, --target-dev-hub=<value>  (required) Username or alias of the Dev Hub org. Not
                                 required if the `target-dev-hub` configuration variable is already set.
@@ -115,7 +117,7 @@ GLOBAL FLAGS
 DESCRIPTION
   prodly:checkout command
 
-  Launches an Prodly relational data deployment.
+  Deploy data from a VCS repository branch to a Salesforce environment.
 
 EXAMPLES
   $ sf prodly:checkin --target-org test-utxac7gbati9@example.com --target-dev-hub jsmith@acme.com
@@ -160,7 +162,7 @@ GLOBAL FLAGS
 DESCRIPTION
   prodly:deploy command
 
-  Launches an Prodly relational data deployment.
+  Deploy data from one Salesforce environment directly to another Salesforce environment.
 
 EXAMPLES
   $ sf prodly:deploy -n scratchorg -u FixesScratchOrg -v MainDevHub
@@ -206,7 +208,7 @@ GLOBAL FLAGS
 DESCRIPTION
   prodly:manage command
 
-  Launches an Prodly relational data deployment.
+  Authorize (or unauthorize) a Salesforce environment (not already added to the Environments page in Release tab) for use by the plugin.
 
 EXAMPLES
   $ sf prodly:manage -l -p
@@ -224,7 +226,7 @@ EXAMPLES
 
 ```
 USAGE
-  $ sf prodly jobs -v <value> -j <value> [--json]
+  $ sf prodly:jobs -v <value> -j <value> [--json]
 
 FLAGS
   -j, --job=<value>             (required) Prodly Job ID
@@ -237,13 +239,47 @@ GLOBAL FLAGS
 DESCRIPTION
   prodly:jobs command
 
-  Launches an Prodly relational data deployment.
+  Check the job status.
 
 EXAMPLES
   $ sf prodly:jobs -j jobId -v MainDevHub
   Print the job status for the provided job Id.
 ```
 
+## `sf prodly:version`
+
+```
+USAGE
+  $ sf prodly:version -s <value> -v <value> -o <value> [--json] [-b <value>] [-i <value>]
+
+FLAGS
+  -b, --new-branch=<value>      if provided it creates a new branch based on the source branch that will be used for
+                                version control
+  -i, --instance=<value>        managed instance ID on which to perform the action
+  -o, --target-org=<value>      (required) [default: aandreou@prodly.co.appopsqa3] Username or alias of the target org.
+                                Not required if the `target-org` configuration variable is already set.
+  -s, --source-branch=<value>   (required) the version control branch or the base for the new branch (if provided)
+  -v, --target-dev-hub=<value>  (required) [default: aandreou@prodly.co.appopsqa3] Username or alias of the Dev Hub org.
+                                Not required if the `target-dev-hub` configuration variable is already set.
+
+GLOBAL FLAGS
+  --json               Format output as json.
+
+DESCRIPTION
+  prodly:version command
+
+  Adds version control to a managed environment.
+
+EXAMPLES
+  $ sf prodly:version -s main
+  Add version control to the managed instance identified by the target org. Use the "main" branch.
+  The instance should be managed by the Prodly account associated with the default DevHub control org.
+
+  $ sf prodly:version -s main -b cli-branch -i f50616b6-57b1-4941-802f-ee0e2506f217
+  Add version control to the managed instance identified by the provided ID. Use the "main" branch as a base for a new branch called "cli-branch"
+  The instance should be managed by the Prodly account associated with the default DevHub control org.
+```
+
 <!-- commandsstop -->
 
 <!-- debugging-your-plugin -->

package/messages/prodly.checkout.md

@@ -4,12 +4,12 @@ prodly:checkout command
 
 # examples
 
-- <%= config.bin %> prodly:checkin --target-org test-utxac7gbati9@example.com --target-dev-hub jsmith@acme.com
-  Save managed data to the branch associated with the managed instance identified by the target username.
+- <%= config.bin %> prodly:checkout --target-org test-utxac7gbati9@example.com --target-dev-hub jsmith@acme.com
+  Deploy managed data to the managed instance identified by the target org from the associated branch.
   The instance should be managed by the Prodly account associated with the provided DevHub control org.
-- <%= config.bin %> prodly:checkin -u test-utxac7gbati9@example.com
-  Save managed data to the branch associated with the managed instance identified by the target username.
+- <%= config.bin %> prodly:checkout -u test-utxac7gbati9@example.com
+  Deploy managed data to the managed instance org identified by the target username from the associated branch.
   The instance should be managed by the Prodly account associated with the default DevHub control org.
-- <%= config.bin %> prodly:checkin -i f50616b6-57b1-4941-802f-ee0e2506f217
-  Save managed data to the branch associated with the managed instance identified by the provided ID.
+- <%= config.bin %> prodly:checkout -i f50616b6-57b1-4941-802f-ee0e2506f217
+  Deploy managed data to the managed instance org from the associated branch.
   The instance should be managed by the Prodly account associated with the default DevHub control org.

package/messages/prodly.json

@@ -1,6 +1,5 @@
 {
   "branchFlagDescription": "branch name for deployment",
-  "commandDescription": "Launches an Prodly relational data deployment.",
   "commentFlagDescription": "comment for the command versioning commit",
   "connectionFlagDescription": "connection to use for the managed instance",
   "dataSetFlagDescription": "name or record ID of the data set to deploy",
@@ -10,16 +9,18 @@
   "destinationFlagDescription": "destination managed instance ID",
   "instanceFlagDescription": "managed instance ID on which to perform the action",
   "instanceNameFlagDescription": "connection and managed instance name",
+  "jobIdFlagSummary": "Prodly Job ID",
   "listFlagDescription": "list all managed instances",
   "manageFlagDescription": "manage a new instance",
+  "newBranchFlagSummary": "if provided it creates a new branch based on the source branch that will be used for version control",
   "notesFlagDescription": "notes for the deployment",
   "printFlagDescription": "print the managed instances in a standard format in addition to returning structured data",
   "queryFilterFlagDescription": "query filter override for a data set deployment",
   "simulationFlagDescription": "perform a data simulation",
+  "sourceBranchFlagSummary": "the version control branch or the base for the new branch (if provided)",
   "sourceFlagDescription": "source managed instance ID",
   "unmanageFlagDescription": "unmanage the specified instance",
   "versionFlagDescription": "version the new managed instance, branch created and data deployed to the org",
-  "jobIdFlagSummary": "Prodly Job ID",
 
   "errorDatasetAndPlanFlags": "Specify either the data set or deployment plan parameter, but not both.",
   "errorDeploymentNameFlag": "Deployment name flag is required.",
@@ -37,7 +38,15 @@
   "errorNoManageFlags": "No operation flag specified for the manage command",
   "errorNoOrgWithManageFlags": "No org specified with the manage flag",
   "errorPrintFlagNoListFlag": "Print flag only specified with the list operation flag",
+  "errorQueryFilterFlag": "Query filter flag is only applicable for data set deployment",
   "errorVersionFlagNoManageFlag": "Version flag only specified with the manage operation flag",
 
-  "unmanageInstancePrompt": "Unmanaging is a destructive and irreversible change which will delete all record mappings for this instance. Provide the instance ID if you are sure you want to continue? "
+  "unmanageInstancePrompt": "Unmanaging is a destructive and irreversible change which will delete all record mappings for this instance. Provide the instance ID if you are sure you want to continue? ",
+
+  "descriptionCheckinCommand": "Save data from a Salesforce environment to a VCS repository branch.",
+  "descriptionCheckoutCommand": "Deploy data from a VCS repository branch to a Salesforce environment.",
+  "descriptionDeployCommand": "Deploy data from one Salesforce environment directly to another Salesforce environment.",
+  "descriptionJobsCommand": " Check the job status.",
+  "descriptionManageCommand": "Authorize (or unauthorize) a Salesforce environment (not already added to the Environments page in Release tab) for use by the plugin.",
+  "descriptionVersionCommand": "Adds version control to a managed environment."
 }

package/messages/prodly.version.md

@@ -0,0 +1,12 @@
+# summary
+
+prodly:version command
+
+# examples
+
+- <%= config.bin %> prodly:version -s main
+  Add version control to the managed instance identified by the target org. Use the "main" branch.
+  The instance should be managed by the Prodly account associated with the default DevHub control org.
+- <%= config.bin %> prodly:version -s main -b cli-branch -i f50616b6-57b1-4941-802f-ee0e2506f217  
+  Add version control to the managed instance identified by the provided ID. Use the "main" branch as a base for a new branch called "cli-branch"
+  The instance should be managed by the Prodly account associated with the default DevHub control org.