@salesforce/plugin-devops-center 0.1.0-beta.1

package/oclif.manifest.json

@@ -0,0 +1,247 @@
+{
+  "version": "0.1.0-beta.1",
+  "commands": {
+    "deploy:pipeline": {
+      "id": "deploy:pipeline",
+      "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.",
+      "strict": true,
+      "pluginName": "@salesforce/plugin-devops-center",
+      "pluginAlias": "@salesforce/plugin-devops-center",
+      "pluginType": "core",
+      "state": "beta",
+      "aliases": [],
+      "examples": [
+        "Deploy changes in the Staging branch to the Staging environment (sandbox), if the previous stage is the bundling stage:\n<%= config.bin %> <%= command.id %> --devops-center-project-name “Recruiting App” --branch-name staging --devops-center-username MyStagingSandbox --bundle-version-name 1.0",
+        "Deploy all changes in 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": {
+          "name": "json",
+          "type": "boolean",
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "allowNo": false
+        },
+        "branch-name": {
+          "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.",
+          "required": true,
+          "multiple": false
+        },
+        "bundle-version-name": {
+          "name": "bundle-version-name",
+          "type": "option",
+          "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
+        },
+        "deploy-all": {
+          "name": "deploy-all",
+          "type": "boolean",
+          "char": "a",
+          "summary": "Deploy all metadata in branch.",
+          "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",
+          "char": "c",
+          "summary": "Username or alias of the DevOps Center org.",
+          "required": true,
+          "multiple": false
+        },
+        "tests": {
+          "name": "tests",
+          "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.",
+          "multiple": true
+        },
+        "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",
+          "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\".",
+          "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 %> report\".",
+          "helpValue": "<minutes>",
+          "multiple": false,
+          "exclusive": [
+            "async"
+          ],
+          "default": {
+            "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": {},
+      "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.",
+      "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 you want 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 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",
+          "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 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
+        },
+        "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
+        },
+        "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 %> report\".",
+          "helpValue": "<minutes>",
+          "multiple": false,
+          "exclusive": [
+            "async"
+          ],
+          "default": {
+            "quantity": 33,
+            "unit": 0
+          }
+        }
+      },
+      "args": {},
+      "hasDynamicHelp": true
+    }
+  }
+}

package/package.json

@@ -0,0 +1,115 @@
+{
+  "name": "@salesforce/plugin-devops-center",
+  "description": "The DevOps Center CLI plugin provides a command-line alternative to performing equivalent actions in the DevOps Center graphical UI",
+  "version": "0.1.0-beta.1",
+  "author": "Salesforce",
+  "bugs": "https://github.com/forcedotcom/cli/issues",
+  "dependencies": {
+    "@oclif/core": "^2.4.0",
+    "@salesforce/core": "^3.32.11",
+    "@salesforce/kit": "^1.8.2",
+    "@salesforce/sf-plugins-core": "^2.2.4",
+    "tslib": "^2"
+  },
+  "devDependencies": {
+    "@oclif/plugin-command-snapshot": "^3.3.6",
+    "@oclif/test": "^2.3.7",
+    "@salesforce/cli-plugins-testkit": "^3.2.25",
+    "@salesforce/dev-config": "^3.1.0",
+    "@salesforce/dev-scripts": "^3.1.1",
+    "@salesforce/plugin-command-reference": "^2.3.1",
+    "@salesforce/prettier-config": "^0.0.2",
+    "@salesforce/ts-sinon": "1.4.6",
+    "@swc/cli": "^0.1.62",
+    "@swc/core": "1.3.39",
+    "@typescript-eslint/eslint-plugin": "^5.54.0",
+    "@typescript-eslint/parser": "^5.54.1",
+    "chai": "^4.3.7",
+    "eslint": "^8.35.0",
+    "eslint-config-prettier": "^8.7.0",
+    "eslint-config-salesforce": "^1.1.1",
+    "eslint-config-salesforce-license": "^0.2.0",
+    "eslint-config-salesforce-typescript": "^1.1.1",
+    "eslint-plugin-header": "^3.0.0",
+    "eslint-plugin-import": "2.27.5",
+    "eslint-plugin-jsdoc": "^39.6.4",
+    "eslint-plugin-sf-plugin": "^1.11.1",
+    "husky": "^7.0.4",
+    "mocha": "^9.2.2",
+    "nyc": "^15.1.0",
+    "oclif": "^3.7.0",
+    "prettier": "^2.8.3",
+    "pretty-quick": "^3.1.3",
+    "shx": "0.3.4",
+    "sinon": "10.0.0",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.9.4"
+  },
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "files": [
+    "/lib",
+    "/messages",
+    "/oclif.manifest.json",
+    "/schemas"
+  ],
+  "homepage": "https://github.com/salesforcecli/plugin-template-sf",
+  "keywords": [
+    "force",
+    "salesforce",
+    "sfdx",
+    "salesforcedx",
+    "sfdx-plugin",
+    "sf-plugin",
+    "sf"
+  ],
+  "license": "BSD-3-Clause",
+  "main": "lib/index.js",
+  "oclif": {
+    "commands": "./lib/commands",
+    "bin": "sf",
+    "configMeta": "./lib/configMeta",
+    "topicSeparator": " ",
+    "devPlugins": [
+      "@oclif/plugin-help",
+      "@oclif/plugin-command-snapshot",
+      "@salesforce/plugin-command-reference"
+    ],
+    "topics": {
+      "deploy": {
+        "description": "Commands to deploy artifacts to an environment.",
+        "subtopics": {
+          "pipeline": {
+            "description": "Commands to deploy metadata from a pipeline stage to a Salesforce org."
+          }
+        }
+      }
+    }
+  },
+  "repository": "salesforcecli/plugin-template-sf",
+  "scripts": {
+    "build": "sf-build",
+    "clean": "sf-clean",
+    "clean-all": "sf-clean all",
+    "clean:lib": "shx rm -rf lib && shx rm -rf coverage && shx rm -rf .nyc_output && shx rm -f oclif.manifest.json",
+    "compile": "sf-compile",
+    "docs": "sf-docs",
+    "format": "sf-format",
+    "lint": "sf-lint",
+    "postpack": "shx rm -f oclif.manifest.json",
+    "posttest": "yarn lint && yarn test:deprecation-policy && yarn test:json-schema && yarn test:command-reference",
+    "prepack": "sf-prepack",
+    "prepare": "sf-install",
+    "pretest": "sf-compile-test",
+    "test": "sf-test",
+    "test:command-reference": "./bin/dev commandreference:generate --erroronwarnings",
+    "test:deprecation-policy": "./bin/dev snapshot:compare",
+    "test:json-schema": "./bin/dev schema:compare",
+    "test:nuts": "nyc mocha \"**/*.nut.ts\" --slow 4500 --timeout 600000 --parallel",
+    "version": "oclif readme"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/schemas/deploy-pipeline-report.json

@@ -0,0 +1,25 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$ref": "#/definitions/PromotePipelineResult",
+  "definitions": {
+    "PromotePipelineResult": {
+      "type": "object",
+      "properties": {
+        "jobId": {
+          "type": "string"
+        },
+        "status": {
+          "type": "string"
+        },
+        "message": {
+          "type": "string"
+        },
+        "errorDetails": {
+          "type": "string"
+        }
+      },
+      "required": ["jobId"],
+      "additionalProperties": false
+    }
+  }
+}

package/schemas/deploy-pipeline-resume.json

@@ -0,0 +1,25 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$ref": "#/definitions/PromotePipelineResult",
+  "definitions": {
+    "PromotePipelineResult": {
+      "type": "object",
+      "properties": {
+        "jobId": {
+          "type": "string"
+        },
+        "status": {
+          "type": "string"
+        },
+        "message": {
+          "type": "string"
+        },
+        "errorDetails": {
+          "type": "string"
+        }
+      },
+      "required": ["jobId"],
+      "additionalProperties": false
+    }
+  }
+}

package/schemas/deploy-pipeline.json

@@ -0,0 +1,25 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$ref": "#/definitions/PromotePipelineResult",
+  "definitions": {
+    "PromotePipelineResult": {
+      "type": "object",
+      "properties": {
+        "jobId": {
+          "type": "string"
+        },
+        "status": {
+          "type": "string"
+        },
+        "message": {
+          "type": "string"
+        },
+        "errorDetails": {
+          "type": "string"
+        }
+      },
+      "required": ["jobId"],
+      "additionalProperties": false
+    }
+  }
+}