@salesforce/plugin-devops-center 0.1.0-beta.3 → 1.0.0-beta.2

package/oclif.manifest.json

@@ -1,10 +1,229 @@
 {
-  "version": "0.1.0-beta.3",
+  "version": "1.0.0-beta.2",
   "commands": {
-    "deploy:pipeline": {
-      "id": "deploy:pipeline",
+    "project:deploy:pipeline:quick": {
+      "id": "project:deploy:pipeline:quick",
+      "summary": "Quickly deploy a validated deployment to an org.",
+      "description": "Before you run this command, first create a validated deployment with the \"sf project deploy pipeline validate\" command, which returns a job ID. Validated deployments haven't been deployed to the org yet; you deploy them with this command. Either pass the job ID to this command or use the --use-most-recent flag to use the job ID of the most recently validated deployment. For the quick deploy to succeed, the associated validated deployment must also have succeeded.\n\nExecuting this quick deploy command takes less time than a standard deploy because it skips running Apex tests. These tests were previously run as part of the validation. Validating first and then running a quick deploy is useful if the deployment to your production org take several hours and you don’t want to risk a failed deploy.\n\nThis command doesn't support source-tracking. The source you deploy overwrites the corresponding metadata in your org. This command doesn’t attempt to merge your source with the versions in your org.",
+      "strict": true,
+      "pluginName": "@salesforce/plugin-devops-center",
+      "pluginAlias": "@salesforce/plugin-devops-center",
+      "pluginType": "core",
+      "state": "beta",
+      "aliases": [],
+      "examples": [
+        "Run a quick deploy using your default Devops Center org and a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
+        "Asynchronously run a quick deploy of the most recently validated deployment using an org with alias \"my-prod-org\":\n<%= config.bin %> <%= command.id %> --async --use-most-recent --devops-center-username my-prod-org"
+      ],
+      "flags": {
+        "json": {
+          "name": "json",
+          "type": "boolean",
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "allowNo": false
+        },
+        "async": {
+          "name": "async",
+          "type": "boolean",
+          "summary": "Run the command asynchronously.",
+          "description": "The command immediately returns the job ID and control of the terminal to you. This way, you can continue to use the CLI. To resume the deployment, run \"sf project deploy pipeline resume\". To check the status of the deployment, run \"sf project deploy pipeline report\".",
+          "allowNo": false
+        },
+        "concise": {
+          "name": "concise",
+          "type": "boolean",
+          "summary": "Show concise output of the command result.",
+          "allowNo": false,
+          "exclusive": [
+            "verbose"
+          ]
+        },
+        "verbose": {
+          "name": "verbose",
+          "type": "boolean",
+          "summary": "Show verbose output of the command result.",
+          "allowNo": false
+        },
+        "wait": {
+          "name": "wait",
+          "type": "option",
+          "char": "w",
+          "summary": "Number of minutes to wait for command to complete and display results.",
+          "description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you and returns the job ID. To check the status of the operation, run \"<%= config.bin %> <%= command.id.split(' ').slice(0, -1).join(' ') %> report\".",
+          "helpValue": "<minutes>",
+          "multiple": false,
+          "exclusive": [
+            "async"
+          ],
+          "default": {
+            "quantity": 33,
+            "unit": 0
+          }
+        },
+        "devops-center-username": {
+          "name": "devops-center-username",
+          "type": "option",
+          "char": "c",
+          "summary": "Username or alias of the DevOps Center org.",
+          "required": true,
+          "multiple": false
+        },
+        "job-id": {
+          "name": "job-id",
+          "type": "option",
+          "char": "i",
+          "summary": "Job ID of the validated deployment to quick deploy.",
+          "description": "The job ID is valid for 10 days from when you started the validation.",
+          "multiple": false
+        },
+        "use-most-recent": {
+          "name": "use-most-recent",
+          "type": "boolean",
+          "char": "r",
+          "summary": "Use the job ID of the most recently validated deployment.",
+          "description": "For performance reasons, this flag uses only job IDs that were validated in the past 3 days or less. If your most recent deployment validation was more than 3 days ago, this flag won't find the job ID.",
+          "allowNo": false
+        }
+      },
+      "args": {},
+      "hasDynamicHelp": true
+    },
+    "project:deploy:pipeline:report": {
+      "id": "project:deploy:pipeline:report",
+      "summary": "Check the status of a pipeline deploy operation.",
+      "description": "Run this command by either indicating a job ID or specifying the —use-most-recent flag to use the job ID of the most recent deploy operation.",
+      "strict": true,
+      "pluginName": "@salesforce/plugin-devops-center",
+      "pluginAlias": "@salesforce/plugin-devops-center",
+      "pluginType": "core",
+      "state": "beta",
+      "aliases": [],
+      "examples": [
+        "Check the status using a job ID:\n<%= config.bin %> <%= command.id %> --devops-center-username MyStagingSandbox --job-id 0Af0x000017yLUFCA2",
+        "Check the status of the most recent deploy operation:\n<%= config.bin %> <%= command.id %> --devops-center-username MyStagingSandbox --use-most-recent"
+      ],
+      "flags": {
+        "json": {
+          "name": "json",
+          "type": "boolean",
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "allowNo": false
+        },
+        "devops-center-username": {
+          "name": "devops-center-username",
+          "type": "option",
+          "char": "c",
+          "summary": "Username or alias of the DevOps Center org.",
+          "required": true,
+          "multiple": false
+        },
+        "job-id": {
+          "name": "job-id",
+          "type": "option",
+          "char": "i",
+          "summary": "Job ID of the pipeline deployment to check the status of.",
+          "description": "The job ID is valid for 10 days from when you started the deploy operation.",
+          "multiple": false
+        },
+        "use-most-recent": {
+          "name": "use-most-recent",
+          "type": "boolean",
+          "char": "r",
+          "summary": "Use the job ID of the most recent deploy operation.",
+          "description": "For performance reasons, this flag uses job IDs for deploy operations that started in the past 3 days or fewer. If your most recent operation was longer than 3 days ago, this flag won't find the job ID.",
+          "allowNo": false
+        }
+      },
+      "args": {},
+      "hasDynamicHelp": true
+    },
+    "project:deploy:pipeline:resume": {
+      "id": "project:deploy:pipeline:resume",
+      "summary": "Resume watching a pipeline deploy operation.",
+      "description": "Use this command to resume watching a pipeline deploy operation if the original command times out or you specified the --async flag.\n\nRun this command by either indicating a job ID or specifying the --use-most-recent flag to use the job ID of the most recent deploy operation.",
+      "strict": true,
+      "pluginName": "@salesforce/plugin-devops-center",
+      "pluginAlias": "@salesforce/plugin-devops-center",
+      "pluginType": "core",
+      "state": "beta",
+      "aliases": [],
+      "examples": [
+        "Resume watching a deploy operation using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
+        "Resume watching the most recent deploy operation:\n<%= config.bin %> <%= command.id %> --use-most-recent"
+      ],
+      "flags": {
+        "json": {
+          "name": "json",
+          "type": "boolean",
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "allowNo": false
+        },
+        "devops-center-username": {
+          "name": "devops-center-username",
+          "type": "option",
+          "char": "c",
+          "summary": "Username or alias of the DevOps Center org.",
+          "required": true,
+          "multiple": false
+        },
+        "job-id": {
+          "name": "job-id",
+          "type": "option",
+          "char": "i",
+          "summary": "Job ID of the pipeline deploy operation you want to resume.",
+          "description": "These commands return a job ID if they time out or you specified the --async flag:\n\n- sf project deploy pipeline start\n- sf project deploy pipeline validate\n- sf project deploy pipeline quick\n\nThe job ID is valid for 10 days from when you started the deploy operation.",
+          "multiple": false
+        },
+        "use-most-recent": {
+          "name": "use-most-recent",
+          "type": "boolean",
+          "char": "r",
+          "summary": "Use the job ID of the most recent deploy operation.",
+          "description": "For performance reasons, this flag uses job IDs for operations that started in the past 3 days or fewer. If your most recent operation was longer than 3 days ago, this flag won't find a job ID.",
+          "allowNo": false
+        },
+        "concise": {
+          "name": "concise",
+          "type": "boolean",
+          "summary": "Show concise output of the command result.",
+          "allowNo": false,
+          "exclusive": [
+            "verbose"
+          ]
+        },
+        "verbose": {
+          "name": "verbose",
+          "type": "boolean",
+          "summary": "Show verbose output of the command result.",
+          "allowNo": false
+        },
+        "wait": {
+          "name": "wait",
+          "type": "option",
+          "char": "w",
+          "summary": "Number of minutes to wait for command to complete and display results.",
+          "description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you and returns the job ID. To check the status of the operation, run \"<%= config.bin %> <%= command.id.split(' ').slice(0, -1).join(' ') %> report\".",
+          "helpValue": "<minutes>",
+          "multiple": false,
+          "exclusive": [
+            "async"
+          ],
+          "default": {
+            "quantity": 33,
+            "unit": 0
+          }
+        }
+      },
+      "args": {},
+      "hasDynamicHelp": true
+    },
+    "project:deploy:pipeline:start": {
+      "id": "project:deploy:pipeline:start",
       "summary": "Deploy changes from a branch to the pipeline stage’s org.",
-      "description": "Before you run this command, changes in the branch must be merged in the source control repository.",
+      "description": "Before you run this command, changes in the pipeline stage's branch must be merged in the source control repository.",
       "strict": true,
       "pluginName": "@salesforce/plugin-devops-center",
       "pluginAlias": "@salesforce/plugin-devops-center",
@@ -27,7 +246,7 @@
           "name": "branch-name",
           "type": "option",
           "char": "b",
-          "summary": "Name of the branch in the source control repository from which to deploy changes to the stage’s org.",
+          "summary": "Name of the branch in the source control repository that corresponds to the pipeline stage that you want to deploy the changes to.",
           "required": true,
           "multiple": false
         },
@@ -43,7 +262,7 @@
           "name": "deploy-all",
           "type": "boolean",
           "char": "a",
-          "summary": "Deploy all metadata in branch.",
+          "summary": "Deploy all metadata in the branch to the stage's org.",
           "description": "If you don’t specify this flag, only changes in the stage’s branch are deployed.",
           "allowNo": false
         },
@@ -68,7 +287,7 @@
           "type": "option",
           "char": "t",
           "summary": "Apex tests to run when --test-level is RunSpecifiedTests.",
-          "description": "Separate multiple test names with commas, and enclose the entire flag value in double quotes if a test name contains a space.",
+          "description": "Separate multiple test names with commas. Enclose the entire flag value in double quotes if a test name contains spaces.",
           "multiple": true
         },
         "test-level": {
@@ -89,7 +308,7 @@
           "name": "async",
           "type": "boolean",
           "summary": "Run the command asynchronously.",
-          "description": "The command immediately returns the job ID and control of the terminal to you. This way, you can continue to use the CLI. To resume the deployment, run \"sf deploy pipeline resume\". To check the status of the deployment, run \"sf deploy pipeline report\".",
+          "description": "The command immediately returns the job ID and control of the terminal to you. This way, you can continue to use the CLI. To resume the deployment, run \"sf project deploy pipeline resume\". To check the status of the deployment, run \"sf project deploy pipeline report\".",
           "allowNo": false
         },
         "wait": {
@@ -97,7 +316,7 @@
           "type": "option",
           "char": "w",
           "summary": "Number of minutes to wait for command to complete and display results.",
-          "description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you and returns the job ID. To check the status of the operation, run \"<%= config.bin %> <%= command.id %> report\".",
+          "description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you and returns the job ID. To check the status of the operation, run \"<%= config.bin %> <%= command.id.split(' ').slice(0, -1).join(' ') %> report\".",
           "helpValue": "<minutes>",
           "multiple": false,
           "exclusive": [
@@ -127,10 +346,10 @@
       "args": {},
       "hasDynamicHelp": true
     },
-    "deploy:pipeline:report": {
-      "id": "deploy:pipeline:report",
-      "summary": "Check the status of a pipeline deploy operation.",
-      "description": "Run this command by either passing it a job ID or specifying the —use-most-recent flag to use the job ID of the most recent deploy operation.",
+    "project:deploy:pipeline:validate": {
+      "id": "project:deploy:pipeline:validate",
+      "summary": "Perform a validate-only deployment from a branch to the pipeline stage’s org.",
+      "description": "A validation runs Apex tests to verify whether a deployment will succeed without actually deploying the metadata to your environment, so you can then quickly deploy the changes later without re-running the tests.",
       "strict": true,
       "pluginName": "@salesforce/plugin-devops-center",
       "pluginAlias": "@salesforce/plugin-devops-center",
@@ -138,8 +357,8 @@
       "state": "beta",
       "aliases": [],
       "examples": [
-        "Check the status using a job ID:\n<%= config.bin %> <%= command.id %> --devops-center-username MyStagingSandbox --job-id 0Af0x000017yLUFCA2",
-        "Check the status of the most recent deploy operation:\n<%= config.bin %> <%= command.id %> --devops-center-username MyStagingSandbox --use-most-recent"
+        "Perform a validate-only deployment from the Staging branch to the Staging environment (sandbox):\n<%= config.bin %> <%= command.id %> --devops-center-project-name “Recruiting App” --branch-name staging --devops-center-username MyStagingSandbox",
+        "Perform a validate-only deployment of all changes from the main branch to the release environment:\n<%= config.bin %> <%= command.id %> --devops-center-project-name “Recruiting App” --branch-name main --devops-center-username MyReleaseOrg --deploy-all"
       ],
       "flags": {
         "json": {
@@ -149,56 +368,38 @@
           "helpGroup": "GLOBAL",
           "allowNo": false
         },
-        "devops-center-username": {
-          "name": "devops-center-username",
+        "branch-name": {
+          "name": "branch-name",
           "type": "option",
-          "char": "c",
-          "summary": "Username or alias of the DevOps Center org.",
+          "char": "b",
+          "summary": "Name of the branch in the source control repository that corresponds to the pipeline stage that you want to deploy the changes to.",
           "required": true,
           "multiple": false
         },
-        "job-id": {
-          "name": "job-id",
+        "bundle-version-name": {
+          "name": "bundle-version-name",
           "type": "option",
-          "char": "i",
-          "summary": "Job ID of the pipeline deployment you want to check the status of.",
-          "description": "The job ID is valid for 10 days from when you started the deploy operation.",
+          "char": "v",
+          "summary": "Version name of the bundle.",
+          "description": "You must indicate the bundle version if deploying to the environment that corresponds to the first stage after the bundling stage.",
           "multiple": false
         },
-        "use-most-recent": {
-          "name": "use-most-recent",
-          "type": "boolean",
-          "char": "r",
-          "summary": "Use the job ID of the most recent deploy operation.",
-          "description": "For performance reasons, this flag uses job IDs for deploy operations that started in the past 3 days or fewer. If your most recent operation was longer than 3 days ago, this flag won't find a job ID.",
-          "allowNo": false
-        }
-      },
-      "args": {},
-      "hasDynamicHelp": true
-    },
-    "deploy:pipeline:resume": {
-      "id": "deploy:pipeline:resume",
-      "summary": "Resume watching a pipeline deploy operation.",
-      "description": "Use this command to resume watching a pipeline deploy operation if the original command times out or you specified the --async flag.\n\nRun this command by either passing it a job ID or specifying the --use-most-recent flag to use the job ID of the most recent deploy operation.",
-      "strict": true,
-      "pluginName": "@salesforce/plugin-devops-center",
-      "pluginAlias": "@salesforce/plugin-devops-center",
-      "pluginType": "core",
-      "state": "beta",
-      "aliases": [],
-      "examples": [
-        "Resume watching a deploy operation using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
-        "Resume watching the most recent deploy operation:\n<%= config.bin %> <%= command.id %> --use-most-recent"
-      ],
-      "flags": {
-        "json": {
-          "name": "json",
+        "deploy-all": {
+          "name": "deploy-all",
           "type": "boolean",
-          "description": "Format output as json.",
-          "helpGroup": "GLOBAL",
+          "char": "a",
+          "summary": "Deploy all metadata in the branch to the stage's org.",
+          "description": "If you don’t specify this flag, only changes in the stage’s branch are deployed.",
           "allowNo": false
         },
+        "devops-center-project-name": {
+          "name": "devops-center-project-name",
+          "type": "option",
+          "char": "p",
+          "summary": "Name of the DevOps Center project.",
+          "required": true,
+          "multiple": false
+        },
         "devops-center-username": {
           "name": "devops-center-username",
           "type": "option",
@@ -207,20 +408,33 @@
           "required": true,
           "multiple": false
         },
-        "job-id": {
-          "name": "job-id",
+        "tests": {
+          "name": "tests",
           "type": "option",
-          "char": "i",
-          "summary": "Job ID of the pipeline deploy operation you want to resume.",
-          "description": "These commands return a job ID if they time out or you specified the --async flag:\n\n- sf deploy pipeline\n- sf deploy pipeline validate\n- sf deploy pipeline quick\n\nThe job ID is valid for 10 days from when you started the deploy operation.",
-          "multiple": false
+          "char": "t",
+          "summary": "Apex tests to run when --test-level is RunSpecifiedTests.",
+          "description": "Separate multiple test names with commas. Enclose the entire flag value in double quotes if a test name contains spaces.",
+          "multiple": true
         },
-        "use-most-recent": {
-          "name": "use-most-recent",
+        "test-level": {
+          "name": "test-level",
+          "type": "option",
+          "char": "l",
+          "summary": "Deployment Apex testing level.",
+          "description": "Valid values are:\n\n- NoTestRun — No tests are run. This test level applies only to deployments to development environments, such as sandbox, Developer Edition, or trial orgs. This test level is the default for development environments.\n\n- RunSpecifiedTests — Runs only the tests that you specify with the --run-tests flag. Code coverage requirements differ from the default coverage requirements when using this test level. Executed tests must comprise a minimum of 75% code coverage for each class and trigger in the deployment package. This coverage is computed for each class and trigger individually and is different than the overall coverage percentage.\n\n- RunLocalTests — All tests in your org are run, except the ones that originate from installed managed and unlocked packages. This test level is the default for production deployments that include Apex classes or triggers.\n\n- RunAllTestsInOrg — All tests in your org are run, including tests of managed packages.\n\nIf you don’t specify a test level, the default behavior depends on the contents of your deployment package. For more information, see [Running Tests in a Deployment](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy_running_tests.htm) in the \"Metadata API Developer Guide\".",
+          "multiple": false,
+          "options": [
+            "NoTestRun",
+            "RunSpecifiedTests",
+            "RunLocalTests",
+            "RunAllTestsInOrg"
+          ]
+        },
+        "async": {
+          "name": "async",
           "type": "boolean",
-          "char": "r",
-          "summary": "Use the job ID of the most recent deploy operation.",
-          "description": "For performance reasons, this flag uses job IDs for operations that started in the past 3 days or fewer. If your most recent operation was longer than 3 days ago, this flag won't find a job ID.",
+          "summary": "Run the command asynchronously.",
+          "description": "The command immediately returns the job ID and control of the terminal to you. This way, you can continue to use the CLI. To resume the deployment, run \"sf project deploy pipeline resume\". To check the status of the deployment, run \"sf project deploy pipeline report\".",
           "allowNo": false
         },
         "wait": {
@@ -228,7 +442,7 @@
           "type": "option",
           "char": "w",
           "summary": "Number of minutes to wait for command to complete and display results.",
-          "description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you and returns the job ID. To check the status of the operation, run \"<%= config.bin %> <%= command.id %> report\".",
+          "description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you and returns the job ID. To check the status of the operation, run \"<%= config.bin %> <%= command.id.split(' ').slice(0, -1).join(' ') %> report\".",
           "helpValue": "<minutes>",
           "multiple": false,
           "exclusive": [
@@ -238,6 +452,21 @@
             "quantity": 33,
             "unit": 0
           }
+        },
+        "verbose": {
+          "name": "verbose",
+          "type": "boolean",
+          "summary": "Show verbose output of the command result.",
+          "allowNo": false
+        },
+        "concise": {
+          "name": "concise",
+          "type": "boolean",
+          "summary": "Show concise output of the command result.",
+          "allowNo": false,
+          "exclusive": [
+            "verbose"
+          ]
         }
       },
       "args": {},