chore: command reference, schema, snapshots

salesforcecli · Jan 11, 2024 · 7f6563f · 7f6563f
1 parent 3c17905
commit 7f6563f
Show file tree

Hide file tree

Showing 15 changed files with 612 additions and 89 deletions.
diff --git a/command-snapshot.json b/command-snapshot.json
@@ -1,7 +1,9 @@
 [
   {
+    "alias": [],
     "command": "channel:promote",
-    "plugin": "@salesforce/plugin-release-management",
+    "flagAliases": ["candidate", "maxage", "target", "targets"],
+    "flagChars": ["C", "T", "c", "d", "i", "m", "p", "s", "t", "v", "x"],
     "flags": [
       "architecture-target",
       "cli",
@@ -16,45 +18,45 @@
       "version",
       "xz"
     ],
-    "alias": [],
-    "flagChars": ["C", "T", "c", "d", "i", "m", "p", "s", "t", "v", "x"],
-    "flagAliases": ["candidate", "maxage", "target", "targets"]
+    "plugin": "@salesforce/plugin-release-management"
   },
   {
-    "command": "cli:artifacts:compare",
-    "plugin": "@salesforce/plugin-release-management",
-    "flags": ["current", "json", "plugin", "previous"],
     "alias": [],
+    "command": "cli:artifacts:compare",
+    "flagAliases": [],
     "flagChars": ["c", "p", "r"],
-    "flagAliases": []
+    "flags": ["current", "json", "plugin", "previous"],
+    "plugin": "@salesforce/plugin-release-management"
   },
   {
-    "command": "cli:install:jit:test",
-    "plugin": "@salesforce/plugin-release-management",
-    "flags": ["jit-plugin", "json"],
     "alias": [],
+    "command": "cli:install:jit:test",
+    "flagAliases": [],
     "flagChars": ["j"],
-    "flagAliases": []
+    "flags": ["jit-plugin", "json"],
+    "plugin": "@salesforce/plugin-release-management"
   },
   {
-    "command": "cli:install:test",
-    "plugin": "@salesforce/plugin-release-management",
-    "flags": ["channel", "cli", "json", "method", "output-file"],
     "alias": [],
+    "command": "cli:install:test",
+    "flagAliases": [],
     "flagChars": ["c", "m"],
-    "flagAliases": []
+    "flags": ["channel", "cli", "json", "method", "output-file"],
+    "plugin": "@salesforce/plugin-release-management"
   },
   {
-    "command": "cli:release:automerge",
-    "plugin": "@salesforce/plugin-release-management",
-    "flags": ["dry-run", "json", "owner", "pull-number", "repo", "verbose"],
     "alias": [],
+    "command": "cli:release:automerge",
+    "flagAliases": ["org"],
     "flagChars": ["d"],
-    "flagAliases": ["org"]
+    "flags": ["dry-run", "json", "owner", "pull-number", "repo", "verbose"],
+    "plugin": "@salesforce/plugin-release-management"
   },
   {
+    "alias": ["cli:latestrc:build"],
     "command": "cli:release:build",
-    "plugin": "@salesforce/plugin-release-management",
+    "flagAliases": ["rctag"],
+    "flagChars": ["c", "d", "g"],
     "flags": [
       "build-only",
       "empty",
@@ -70,104 +72,94 @@
       "start-from-github-ref",
       "start-from-npm-dist-tag"
     ],
-    "alias": ["cli:latestrc:build"],
-    "flagChars": ["c", "d", "g"],
-    "flagAliases": ["rctag"]
+    "plugin": "@salesforce/plugin-release-management"
   },
   {
-    "command": "cli:releasenotes",
-    "plugin": "@salesforce/plugin-release-management",
-    "flags": ["cli", "json", "markdown", "since"],
     "alias": [],
+    "command": "cli:releasenotes",
+    "flagAliases": [],
     "flagChars": ["c", "m", "s"],
-    "flagAliases": []
+    "flags": ["cli", "json", "markdown", "since"],
+    "plugin": "@salesforce/plugin-release-management"
   },
   {
-    "command": "cli:schemas:compare",
-    "plugin": "@salesforce/plugin-release-management",
-    "flags": ["json"],
     "alias": [],
-    "flagChars": [],
-    "flagAliases": []
-  },
-  {
     "command": "cli:tarballs:prepare",
-    "plugin": "@salesforce/plugin-release-management",
-    "flags": ["dryrun", "json", "types", "verbose"],
-    "alias": [],
+    "flagAliases": [],
     "flagChars": ["d", "t"],
-    "flagAliases": []
+    "flags": ["dryrun", "json", "types", "verbose"],
+    "plugin": "@salesforce/plugin-release-management"
   },
   {
-    "command": "cli:tarballs:smoke",
-    "plugin": "@salesforce/plugin-release-management",
-    "flags": ["json", "verbose"],
     "alias": [],
+    "command": "cli:tarballs:smoke",
+    "flagAliases": [],
     "flagChars": [],
-    "flagAliases": []
+    "flags": ["json", "verbose"],
+    "plugin": "@salesforce/plugin-release-management"
   },
   {
-    "command": "cli:tarballs:verify",
-    "plugin": "@salesforce/plugin-release-management",
-    "flags": ["cli", "json", "windows-username-buffer"],
     "alias": [],
+    "command": "cli:tarballs:verify",
+    "flagAliases": [],
     "flagChars": ["c", "w"],
-    "flagAliases": []
+    "flags": ["cli", "json", "windows-username-buffer"],
+    "plugin": "@salesforce/plugin-release-management"
   },
   {
-    "command": "cli:versions:inspect",
-    "plugin": "@salesforce/plugin-release-management",
-    "flags": ["channels", "cli", "dependencies", "json", "locations", "salesforce"],
     "alias": [],
+    "command": "cli:versions:inspect",
+    "flagAliases": [],
     "flagChars": ["c", "d", "l", "s"],
-    "flagAliases": []
+    "flags": ["channels", "cli", "dependencies", "json", "locations", "salesforce"],
+    "plugin": "@salesforce/plugin-release-management"
   },
   {
-    "command": "dependabot:automerge",
-    "plugin": "@salesforce/plugin-release-management",
-    "flags": ["dryrun", "json", "max-version-bump", "merge-method", "owner", "repo", "skip-ci"],
     "alias": [],
+    "command": "dependabot:automerge",
+    "flagAliases": [],
     "flagChars": ["d", "m", "o", "r", "s"],
-    "flagAliases": []
+    "flags": ["dryrun", "json", "max-version-bump", "merge-method", "owner", "repo", "skip-ci"],
+    "plugin": "@salesforce/plugin-release-management"
   },
   {
-    "command": "github:check:closed",
-    "plugin": "@salesforce/plugin-release-management",
-    "flags": ["github-token", "gus", "json"],
     "alias": [],
+    "command": "github:check:closed",
+    "flagAliases": [],
     "flagChars": ["o"],
-    "flagAliases": []
+    "flags": ["github-token", "gus", "json"],
+    "plugin": "@salesforce/plugin-release-management"
   },
   {
-    "command": "npm:dependencies:pin",
-    "plugin": "@salesforce/plugin-release-management",
-    "flags": ["dryrun", "json", "tag"],
     "alias": [],
+    "command": "npm:dependencies:pin",
+    "flagAliases": [],
     "flagChars": ["d", "t"],
-    "flagAliases": []
+    "flags": ["dryrun", "json", "tag"],
+    "plugin": "@salesforce/plugin-release-management"
   },
   {
-    "command": "npm:package:release",
-    "plugin": "@salesforce/plugin-release-management",
-    "flags": ["dryrun", "githubtag", "install", "json", "npmaccess", "npmtag", "prerelease", "sign", "verify"],
     "alias": [],
+    "command": "npm:package:release",
+    "flagAliases": [],
     "flagChars": ["a", "d", "s", "t"],
-    "flagAliases": []
+    "flags": ["dryrun", "githubtag", "install", "json", "npmaccess", "npmtag", "prerelease", "sign", "verify"],
+    "plugin": "@salesforce/plugin-release-management"
   },
   {
-    "command": "plugins:trust:verify",
-    "plugin": "@salesforce/plugin-trust",
-    "flags": ["json", "loglevel", "npm", "registry"],
     "alias": [],
+    "command": "plugins:trust:verify",
+    "flagAliases": [],
     "flagChars": ["n", "r"],
-    "flagAliases": []
+    "flags": ["json", "loglevel", "npm", "registry"],
+    "plugin": "@salesforce/plugin-trust"
   },
   {
-    "command": "repositories",
-    "plugin": "@salesforce/plugin-release-management",
-    "flags": ["columns", "csv", "extended", "filter", "json", "no-header", "no-truncate", "output", "sort"],
     "alias": [],
+    "command": "repositories",
+    "flagAliases": [],
     "flagChars": ["x"],
-    "flagAliases": []
+    "flags": ["columns", "csv", "extended", "filter", "json", "no-header", "no-truncate", "output", "sort"],
+    "plugin": "@salesforce/plugin-release-management"
   }
 ]
diff --git a/schemas/channel-promote.json b/schemas/channel-promote.json
@@ -0,0 +1,38 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$ref": "#/definitions/PromoteResult",
+  "definitions": {
+    "PromoteResult": {
+      "type": "object",
+      "properties": {
+        "dryRun": {
+          "type": "boolean"
+        },
+        "cli": {
+          "$ref": "#/definitions/CLI"
+        },
+        "target": {
+          "type": "string"
+        },
+        "sha": {
+          "type": "string"
+        },
+        "version": {
+          "type": "string"
+        },
+        "platforms": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      },
+      "required": ["dryRun", "cli", "target", "sha", "version", "platforms"],
+      "additionalProperties": false
+    },
+    "CLI": {
+      "type": "string",
+      "enum": ["sf", "sfdx"]
+    }
+  }
+}