@salesforce/plugin-release-management

{ "commands": { "channel:promote": { "aliases": [], "args": {}, "description": "promote a s3 channel", "examples": [ "<%= config.bin %> <%= command.id %> --candidate latest-rc --target latest --platform win --platform mac" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "dryrun": { "char": "d", "name": "dryrun", "summary": "If true, only show what would happen", "allowNo": false, "type": "boolean" }, "promote-to-channel": { "aliases": [ "target" ], "char": "t", "name": "promote-to-channel", "required": true, "summary": "the channel name that you are promoting to", "default": "stable", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "promote-from-channel": { "aliases": [ "candidate" ], "char": "C", "name": "promote-from-channel", "summary": "the channel name that you want to promote", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "platform": { "char": "p", "name": "platform", "summary": "the platform to promote", "delimiter": ",", "hasDynamicHelp": false, "multiple": true, "options": [ "win", "macos", "deb" ], "type": "option" }, "cli": { "char": "c", "name": "cli", "required": true, "summary": "the cli name to promote", "hasDynamicHelp": false, "multiple": false, "options": [ "sf", "sfdx" ], "type": "option" }, "sha": { "char": "s", "name": "sha", "summary": "the short sha to promote", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "max-age": { "aliases": [ "maxage" ], "char": "m", "name": "max-age", "summary": "cache control max-age in seconds", "default": 300, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "indexes": { "char": "i", "name": "indexes", "summary": "append the promoted urls into the index files", "allowNo": true, "type": "boolean" }, "xz": { "char": "x", "name": "xz", "summary": "also upload xz", "allowNo": true, "type": "boolean" }, "architecture-target": { "aliases": [ "targets" ], "char": "T", "name": "architecture-target", "summary": "comma-separated targets to promote (e.g.: linux-arm,win32-x64)", "delimiter": ",", "hasDynamicHelp": false, "multiple": true, "options": [ "linux-x64", "linux-arm", "win32-x64", "win32-x86", "darwin-x64" ], "type": "option" }, "version": { "char": "v", "name": "version", "summary": "the version of the candidate to be promoted, which must exist already in s3. Used to fetch the correct sha", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "channel:promote", "pluginAlias": "@salesforce/plugin-release-management", "pluginName": "@salesforce/plugin-release-management", "pluginType": "core", "strict": true, "summary": "promote a s3 channel", "enableJsonFlag": true, "isESM": true, "relativePath": [ "lib", "commands", "channel", "promote.js" ] }, "cli:releasenotes": { "aliases": [], "args": {}, "description": "pull all relevant information for writing release notes.\nRequires the GH_TOKEN to be set in the environment.", "examples": [ "<%= config.bin %> <%= command.id %> --cli sf", "<%= config.bin %> <%= command.id %> --cli sfdx", "<%= config.bin %> <%= command.id %> --cli sf --since 1.0.0", "<%= config.bin %> <%= command.id %> --cli sfdx --since 7.19.0", "<%= config.bin %> <%= command.id %> --cli sf > changes.txt", "<%= config.bin %> <%= command.id %> --cli sf --markdown > changes.md" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "cli": { "char": "c", "name": "cli", "required": true, "summary": "the cli to pull information for", "hasDynamicHelp": false, "multiple": false, "options": [ "sf", "sfdx" ], "type": "option" }, "since": { "char": "s", "name": "since", "summary": "the version number of the previous release. Defaults to the latest-rc version on npm", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "markdown": { "char": "m", "name": "markdown", "summary": "format the output in markdown", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cli:releasenotes", "pluginAlias": "@salesforce/plugin-release-management", "pluginName": "@salesforce/plugin-release-management", "pluginType": "core", "strict": true, "summary": "pull all relevant information for writing release notes.\nRequires the GH_TOKEN to be set in the environment.", "enableJsonFlag": true, "isESM": true, "relativePath": [ "lib", "commands", "cli", "releasenotes.js" ] }, "dependabot:automerge": { "aliases": [], "args": {}, "description": "automatically merge one green, mergeable PR up to the specified maximum bump type", "examples": [ "<%= config.bin %> <%= command.id %> --max-version-bump patch", "<%= config.bin %> <%= command.id %> --max-version-bump minor", "<%= config.bin %> <%= command.id %> --max-version-bump major" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "owner": { "char": "o", "dependsOn": [ "repo" ], "name": "owner", "summary": "the organization that the repository belongs to. This defaults to the owner specified in the package.json", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "repo": { "char": "r", "dependsOn": [ "owner" ], "name": "repo", "summary": "the repository you want to consolidate PRs on. This defaults to the repository specified in the package.json", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "max-version-bump": { "char": "m", "description": "the maximum version bump you want to be included", "name": "max-version-bump", "required": true, "default": "minor", "hasDynamicHelp": false, "multiple": false, "options": [ "major", "minor", "patch" ], "type": "option" }, "dryrun": { "char": "d", "name": "dryrun", "summary": "only show what would happen if you consolidated dependabot PRs", "allowNo": false, "type": "boolean" }, "skip-ci": { "char": "s", "name": "skip-ci", "summary": "add [skip ci] to the merge commit title", "allowNo": false, "type": "boolean" }, "merge-method": { "name": "merge-method", "summary": "merge method to use", "default": "merge", "hasDynamicHelp": false, "multiple": false, "options": [ "merge", "squash", "rebase" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "dependabot:automerge", "pluginAlias": "@salesforce/plugin-release-management", "pluginName": "@salesforce/plugin-release-management", "pluginType": "core", "strict": true, "summary": "automatically merge one green, mergeable PR up to the specified maximum bump type", "enableJsonFlag": true, "isESM": true, "relativePath": [ "lib", "commands", "dependabot", "automerge.js" ] }, "repositories": { "aliases": [], "args": {}, "description": "list repositories owned and supported by Salesforce CLI\nFor more information on the list of repositories, visit https://github.com/salesforcecli/status.", "examples": [ "<%= config.bin %> <%= command.id %> --columns=url --filter='Name=sfdx-core' --no-header | xargs open", "<%= config.bin %> <%= command.id %> --json | jq -r '.result[] | select(.name==\"sfdx-core\") | .packages[] | .url" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "columns": { "exclusive": [ "extended" ], "name": "columns", "summary": "Only show provided columns (comma-separated).", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "csv": { "exclusive": [ "no-truncate" ], "name": "csv", "summary": "Output is csv format.", "allowNo": false, "type": "boolean" }, "extended": { "char": "x", "exclusive": [ "columns" ], "name": "extended", "summary": "Show extra columns.", "allowNo": false, "type": "boolean" }, "filter": { "name": "filter", "summary": "Filter property by partial string matching, ex: name=foo.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-header": { "exclusive": [ "csv" ], "name": "no-header", "summary": "Hide table header from output.", "allowNo": false, "type": "boolean" }, "no-truncate": { "exclusive": [ "csv" ], "name": "no-truncate", "summary": "Do not truncate output to fit screen.", "allowNo": false, "type": "boolean" }, "output": { "exclusive": [ "no-truncate", "csv" ], "name": "output", "summary": "Output in a more machine friendly format.", "hasDynamicHelp": false, "multiple": false, "options": [ "csv", "json", "yaml" ], "type": "option" }, "sort": { "name": "sort", "summary": "Property to sort by (prepend '-' for descending).", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "repositories", "pluginAlias": "@salesforce/plugin-release-management", "pluginName": "@salesforce/plugin-release-management", "pluginType": "core", "strict": true, "summary": "list repositories owned and supported by Salesforce CLI\nFor more information on the list of repositories, visit https://github.com/salesforcecli/status.", "enableJsonFlag": true, "isESM": true, "relativePath": [ "lib", "commands", "repositories", "index.js" ] }, "cli:artifacts:compare": { "aliases": [], "args": {}, "examples": [ "<%= config.bin %> <%= command.id %>" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "plugin": { "char": "p", "name": "plugin", "summary": "List of plugins to check for breaking changes.", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "previous": { "char": "r", "name": "previous", "summary": "Previous CLI version to compare against. Defaults to the last published version.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "current": { "char": "c", "name": "current", "summary": "Current CLI version to compare against. Defaults to the version on the CLI in the current directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cli:artifacts:compare", "pluginAlias": "@salesforce/plugin-release-management", "pluginName": "@salesforce/plugin-release-management", "pluginType": "core", "strict": true, "summary": "Look for breaking changes in artifacts (schemas and snapshots) from plugins. Must be run in CLI directory.", "enableJsonFlag": true, "isESM": true, "relativePath": [ "lib", "commands", "cli", "artifacts", "compare.js" ] }, "cli:install:test": { "aliases": [], "args": {}, "description": "install sf or sfdx", "examples": [ "<%= config.bin %> <%= command.id %> --cli sfdx --method installer", "<%= config.bin %> <%= command.id %> --cli sfdx --method npm", "<%= config.bin %> <%= command.id %> --cli sfdx --method tarball", "<%= config.bin %> <%= command.id %> --cli sf --method tarball", "<%= config.bin %> <%= command.id %> --cli sf --method tarball --channel stable-rc" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "cli": { "char": "c", "name": "cli", "required": true, "summary": "the cli to install", "hasDynamicHelp": false, "multiple": false, "options": [ "sf", "sfdx" ], "type": "option" }, "method": { "char": "m", "name": "method", "required": true, "summary": "the installation method to use", "hasDynamicHelp": false, "multiple": false, "options": [ "installer", "npm", "tarball" ], "type": "option" }, "channel": { "name": "channel", "summary": "the channel to install from", "default": "stable", "hasDynamicHelp": false, "multiple": false, "options": [ "legacy", "stable", "stable-rc", "latest", "latest-rc" ], "type": "option" }, "output-file": { "name": "output-file", "summary": "the file to write the JSON results to (must be .json)", "default": "test-results.json", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cli:install:test", "pluginAlias": "@salesforce/plugin-release-management", "pluginName": "@salesforce/plugin-release-management", "pluginType": "core", "strict": true, "summary": "install sf or sfdx", "enableJsonFlag": true, "isESM": true, "relativePath": [ "lib", "commands", "cli", "install", "test.js" ] }, "cli:release:automerge": { "aliases": [], "args": {}, "description": "Attempt to automerge nightly PR", "examples": [ "<%= config.bin %> <%= command.id %> --owner salesforcecli --repo sfdx-cli --pul-number 1049" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "owner": { "aliases": [ "org" ], "dependsOn": [ "repo" ], "name": "owner", "required": true, "summary": "Github owner (org), example: salesforcecli", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "repo": { "dependsOn": [ "owner" ], "name": "repo", "required": true, "summary": "Github repo, example: sfdx-cli", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "pull-number": { "name": "pull-number", "required": true, "summary": "Github pull request number to merge", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "dry-run": { "char": "d", "name": "dry-run", "summary": "Run all checks, but do not merge PR", "allowNo": false, "type": "boolean" }, "verbose": { "name": "verbose", "summary": "Show additional debug output", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cli:release:automerge", "pluginAlias": "@salesforce/plugin-release-management", "pluginName": "@salesforce/plugin-release-management", "pluginType": "core", "strict": true, "summary": "Attempt to automerge nightly PR", "enableJsonFlag": true, "isESM": true, "relativePath": [ "lib", "commands", "cli", "release", "automerge.js" ] }, "cli:release:build": { "aliases": [ "cli:latestrc:build" ], "args": {}, "description": "builds a new release from a designated starting point and optionally creates PR in Github", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --patch", "<%= config.bin %> <%= command.id %> --start-from-npm-dist-tag latest-rc --patch", "<%= config.bin %> <%= command.id %> --start-from-github-ref 7.144.0", "<%= config.bin %> <%= command.id %> --start-from-github-ref main", "<%= config.bin %> <%= command.id %> --start-from-github-ref f476e8e", "<%= config.bin %> <%= command.id %> --start-from-github-ref main --prerelease beta", "<%= config.bin %> <%= command.id %> --build-only", "<%= config.bin %> <%= command.id %> --only @salesforce/plugin-source,@salesforce/plugin-info@1.2.3" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "start-from-npm-dist-tag": { "aliases": [ "rctag" ], "char": "d", "deprecateAliases": true, "name": "start-from-npm-dist-tag", "summary": "the npm dist-tag to start the release from, examples: nightly, latest-rc", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "start-from-github-ref": { "char": "g", "name": "start-from-github-ref", "summary": "a Github ref to start the release from, examples: main, 7.144.0, f476e8e", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "release-channel": { "char": "c", "name": "release-channel", "required": true, "summary": "the channel intended for this release, examples: nightly, latest-rc, latest, dev, beta, etc...", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "build-only": { "name": "build-only", "summary": "only build the release, do not git add/commit/push", "allowNo": false, "type": "boolean" }, "resolutions": { "name": "resolutions", "summary": "bump the versions of packages listed in the resolutions section", "allowNo": true, "type": "boolean" }, "only": { "name": "only", "summary": "only bump the version of the packages passed in, uses latest if version is not provided", "delimiter": ",", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "pinned-deps": { "name": "pinned-deps", "summary": "bump the versions of the packages listed in the pinnedDependencies section", "allowNo": true, "type": "boolean" }, "jit": { "name": "jit", "summary": "bump the versions of the packages listed in the jitPlugins (just-in-time) section", "allowNo": true, "type": "boolean" }, "label": { "name": "label", "summary": "add one or more labels to the Github PR", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "patch": { "name": "patch", "summary": "bump the release as a patch of an existing version, not a new minor version", "allowNo": false, "type": "boolean" }, "empty": { "name": "empty", "summary": "create an empty release PR for pushing changes to later (version will still be bumped)", "allowNo": false, "type": "boolean" }, "pr-base-branch": { "name": "pr-base-branch", "summary": "base branch to create the PR against; if not specified, the build determines the branch for you", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cli:release:build", "pluginAlias": "@salesforce/plugin-release-management", "pluginName": "@salesforce/plugin-release-management", "pluginType": "core", "strict": true, "summary": "builds a new release from a designated starting point and optionally creates PR in Github", "enableJsonFlag": true, "isESM": true, "relativePath": [ "lib", "commands", "cli", "release", "build.js" ] }, "cli:tarballs:prepare": { "aliases": [], "args": {}, "description": "remove unnecessary files from node_modules", "examples": [ "<%= config.bin %> <%= command.id %>" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "dryrun": { "char": "d", "name": "dryrun", "summary": "only show what would be removed from node_modules", "allowNo": false, "type": "boolean" }, "types": { "char": "t", "name": "types", "summary": "remove all types (.d.ts) files from node_modules", "allowNo": false, "type": "boolean" }, "verbose": { "name": "verbose", "summary": "show all files paths being removed", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cli:tarballs:prepare", "pluginAlias": "@salesforce/plugin-release-management", "pluginName": "@salesforce/plugin-release-management", "pluginType": "core", "strict": true, "summary": "remove unnecessary files from node_modules", "enableJsonFlag": true, "isESM": true, "relativePath": [ "lib", "commands", "cli", "tarballs", "prepare.js" ] }, "cli:tarballs:smoke": { "aliases": [], "args": {}, "description": "smoke tests for the sf CLI\nTests that the CLI and every command can be initialized.", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %>" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "verbose": { "name": "verbose", "summary": "show the --help output for each command", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cli:tarballs:smoke", "pluginAlias": "@salesforce/plugin-release-management", "pluginName": "@salesforce/plugin-release-management", "pluginType": "core", "strict": true, "summary": "smoke tests for the sf CLI\nTests that the CLI and every command can be initialized.", "enableJsonFlag": true, "isESM": true, "relativePath": [ "lib", "commands", "cli", "tarballs", "smoke.js" ] }, "cli:tarballs:verify": { "aliases": [], "args": {}, "description": "verify that tarballs are ready to be uploaded", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --cli sfdx", "<%= config.bin %> <%= command.id %> --cli sf" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "cli": { "char": "c", "name": "cli", "summary": "the cli to verify", "default": "sfdx", "hasDynamicHelp": false, "multiple": false, "options": [ "sf", "sfdx" ], "type": "option" }, "windows-username-buffer": { "char": "w", "name": "windows-username-buffer", "summary": "the number of characters to allow for windows usernames", "default": 41, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cli:tarballs:verify", "pluginAlias": "@salesforce/plugin-release-management", "pluginName": "@salesforce/plugin-release-management", "pluginType": "core", "strict": true, "summary": "verify that tarballs are ready to be uploaded", "enableJsonFlag": true, "isESM": true, "relativePath": [ "lib", "commands", "cli", "tarballs", "verify.js" ] }, "cli:versions:inspect": { "aliases": [], "args": {}, "description": "inspect the CLI version across all install paths", "examples": [ "<%= config.bin %> <%= command.id %> -l archive -c stable", "<%= config.bin %> <%= command.id %> -l archive -c stable-rc", "<%= config.bin %> <%= command.id %> -l archive npm -c stable", "<%= config.bin %> <%= command.id %> -l archive npm -c latest", "<%= config.bin %> <%= command.id %> -l archive npm -c latest latest-rc", "<%= config.bin %> <%= command.id %> -l archive npm -c stable stable-rc", "<%= config.bin %> <%= command.id %> -l npm -c latest --salesforce", "<%= config.bin %> <%= command.id %> -l npm -c latest -d @salesforce/core", "<%= config.bin %> <%= command.id %> -l npm -c latest -d @salesforce/\\*\\*/ salesforce-alm", "<%= config.bin %> <%= command.id %> -l npm -c latest -d chalk -s" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "dependencies": { "char": "d", "name": "dependencies", "summary": "glob pattern of dependencies you want to see the version of", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "salesforce": { "char": "s", "name": "salesforce", "summary": "show versions of salesforce owned dependencies", "allowNo": false, "type": "boolean" }, "channels": { "char": "c", "name": "channels", "required": true, "summary": "the channel you want to inspect (for achives, latest and latest-rc are translated to stable and stable-rc. And vice-versa for npm)", "hasDynamicHelp": false, "multiple": true, "options": [ "stable", "stable-rc", "latest", "latest-rc", "nightly" ], "type": "option" }, "locations": { "char": "l", "name": "locations", "required": true, "summary": "the location you want to inspect", "hasDynamicHelp": false, "multiple": true, "options": [ "archive", "npm" ], "type": "option" }, "ignore-missing": { "name": "ignore-missing", "summary": "skip missing archives. Useful when supporting new architectures in oclif", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cli:versions:inspect", "pluginAlias": "@salesforce/plugin-release-management", "pluginName": "@salesforce/plugin-release-management", "pluginType": "core", "strict": true, "summary": "inspect the CLI version across all install paths", "enableJsonFlag": true, "isESM": true, "relativePath": [ "lib", "commands", "cli", "versions", "inspect.js" ] }, "github:check:closed": { "aliases": [], "args": {}, "description": "Description of a command.", "examples": [ "<%= config.bin %> <%= command.id %> -o me@gus.com" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "gus": { "char": "o", "name": "gus", "noCacheDefault": true, "required": true, "summary": "Username/alias of your GUS org connection", "hasDynamicHelp": true, "multiple": false, "type": "option" }, "github-token": { "env": "GITHUB_TOKEN", "name": "github-token", "required": true, "summary": "Github token--store this in the environment as GITHUB_TOKEN", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": true, "hiddenAliases": [], "id": "github:check:closed", "pluginAlias": "@salesforce/plugin-release-management", "pluginName": "@salesforce/plugin-release-management", "pluginType": "core", "strict": true, "summary": "Show open Github issues with GUS WI", "enableJsonFlag": true, "isESM": true, "relativePath": [ "lib", "commands", "github", "check", "closed.js" ] }, "npm:dependencies:pin": { "aliases": [], "args": {}, "description": "lock a list of dependencies to a target tag or default to 'latest', place these entries in 'pinnedDependencies' entry in the package.json", "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "dryrun": { "char": "d", "name": "dryrun", "summary": "If true, will not make any changes to the package.json", "allowNo": false, "type": "boolean" }, "tag": { "char": "t", "name": "tag", "summary": "The name of the tag you want, e.g. 'latest-rc', or 'latest'", "default": "latest", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "npm:dependencies:pin", "pluginAlias": "@salesforce/plugin-release-management", "pluginName": "@salesforce/plugin-release-management", "pluginType": "core", "strict": true, "summary": "lock a list of dependencies to a target tag or default to 'latest', place these entries in 'pinnedDependencies' entry in the package.json", "enableJsonFlag": true, "isESM": true, "relativePath": [ "lib", "commands", "npm", "dependencies", "pin.js" ] }, "npm:package:release": { "aliases": [], "args": {}, "description": "publish npm package", "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "dryrun": { "char": "d", "name": "dryrun", "summary": "If true, will not commit changes to repo or push any tags", "allowNo": false, "type": "boolean" }, "sign": { "char": "s", "name": "sign", "summary": "If true, then the package will be signed and the signature will be uploaded to S3", "allowNo": false, "type": "boolean" }, "npmtag": { "char": "t", "name": "npmtag", "summary": "tag to use when publishing to npm", "default": "latest", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "npmaccess": { "char": "a", "name": "npmaccess", "summary": "access level to use when publishing to npm", "default": "public", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "install": { "name": "install", "summary": "run yarn install and build on repository", "allowNo": true, "type": "boolean" }, "prerelease": { "name": "prerelease", "summary": "determine the next version as <version>-<prerelease>.0 if version is not manually set", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "verify": { "name": "verify", "summary": "verify npm registry has new version after publish and digital signature", "allowNo": true, "type": "boolean" }, "githubtag": { "name": "githubtag", "summary": "given a github tag, release the version specified in the package.json as is. Useful when you've already done a release and only need npm publish features", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "npm:package:release", "pluginAlias": "@salesforce/plugin-release-management", "pluginName": "@salesforce/plugin-release-management", "pluginType": "core", "strict": true, "summary": "publish npm package", "enableJsonFlag": true, "isESM": true, "relativePath": [ "lib", "commands", "npm", "package", "release.js" ] }, "cli:install:jit:test": { "aliases": [], "args": {}, "examples": [ "<%= config.bin %> <%= command.id %>" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "jit-plugin": { "char": "j", "name": "jit-plugin", "summary": "JIT plugin(s) to test, example: @salesforce/plugin-community", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cli:install:jit:test", "pluginAlias": "@salesforce/plugin-release-management", "pluginName": "@salesforce/plugin-release-management", "pluginType": "core", "strict": true, "summary": "Test that all JIT plugins can be successfully installed.", "enableJsonFlag": true, "isESM": true, "relativePath": [ "lib", "commands", "cli", "install", "jit", "test.js" ] } }, "version": "5.9.0" }