@salesforce/plugin-release-management 4.4.18 → 4.4.20

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "4.4.18",
+  "version": "4.4.20",
   "commands": {
     "channel:promote": {
       "id": "channel:promote",
@@ -137,8 +137,8 @@
     },
     "cli:releasenotes": {
       "id": "cli:releasenotes",
-      "summary": "pull all relevant information for writing release notes.\n Requires the GH_TOKEN to be set in the environment.",
-      "description": "pull all relevant information for writing release notes.\n Requires the GH_TOKEN to be set in the environment.",
+      "summary": "pull all relevant information for writing release notes.\nRequires the GH_TOKEN to be set in the environment.",
+      "description": "pull all relevant information for writing release notes.\nRequires the GH_TOKEN to be set in the environment.",
       "strict": true,
       "pluginName": "@salesforce/plugin-release-management",
       "pluginAlias": "@salesforce/plugin-release-management",
@@ -721,7 +721,7 @@
           "name": "types",
           "type": "boolean",
           "char": "t",
-          "summary": "remove all types (.d.ts) files from node_modules ",
+          "summary": "remove all types (.d.ts) files from node_modules",
           "allowNo": false
         },
         "verbose": {
@@ -735,8 +735,8 @@
     },
     "cli:tarballs:smoke": {
       "id": "cli:tarballs:smoke",
-      "summary": "smoke tests for the sf CLI\n Tests that the CLI and every command can be initialized.",
-      "description": "smoke tests for the sf CLI\n Tests that the CLI and every command can be initialized.",
+      "summary": "smoke tests for the sf CLI\nTests that the CLI and every command can be initialized.",
+      "description": "smoke tests for the sf CLI\nTests that the CLI and every command can be initialized.",
       "strict": true,
       "pluginName": "@salesforce/plugin-release-management",
       "pluginAlias": "@salesforce/plugin-release-management",
@@ -826,7 +826,7 @@
         "<%= 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 @salesforce/\\*\\*/ salesforce-alm",
         "<%= config.bin %> <%= command.id %> -l npm -c latest -d chalk -s"
       ],
       "flags": {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@salesforce/plugin-release-management",
   "description": "A plugin for preparing and publishing npm packages",
-  "version": "4.4.18",
+  "version": "4.4.20",
   "author": "Salesforce",
   "bugs": "https://github.com/forcedotcom/cli/issues",
   "bin": {
@@ -16,10 +16,10 @@
     "@salesforce/core": "^5.3.14",
     "@salesforce/kit": "^3.0.15",
     "@salesforce/plugin-command-reference": "^3.0.36",
-    "@salesforce/plugin-trust": "^2.6.21",
+    "@salesforce/plugin-trust": "^2.6.22",
     "@salesforce/sf-plugins-core": "^3.1.28",
     "@salesforce/ts-types": "^2.0.9",
-    "aws-sdk": "^2.1467.0",
+    "aws-sdk": "^2.1488.0",
     "chalk": "^4.1.0",
     "fast-glob": "^3.3.1",
     "got": "^11.8.6",
@@ -35,7 +35,7 @@
   "devDependencies": {
     "@oclif/plugin-command-snapshot": "^4.0.14",
     "@salesforce/dev-config": "^4.0.1",
-    "@salesforce/dev-scripts": "^5.11.0",
+    "@salesforce/dev-scripts": "^5.12.2",
     "@salesforce/prettier-config": "^0.0.3",
     "@salesforce/ts-sinon": "1.4.17",
     "@swc/core": "1.3.39",
@@ -45,14 +45,14 @@
     "@typescript-eslint/parser": "^5.61.0",
     "aws-sdk-mock": "^5.8.0",
     "chai": "^4.3.10",
-    "eslint": "^8.49.0",
+    "eslint": "^8.52.0",
     "eslint-config-prettier": "^8.10.0",
     "eslint-config-salesforce": "^2.0.2",
     "eslint-config-salesforce-license": "^0.2.0",
-    "eslint-config-salesforce-typescript": "^1.1.2",
+    "eslint-config-salesforce-typescript": "^2.0.0",
     "eslint-plugin-header": "^3.1.1",
     "eslint-plugin-import": "2.28.1",
-    "eslint-plugin-jsdoc": "^44.2.4",
+    "eslint-plugin-jsdoc": "^46.8.2",
     "eslint-plugin-sf-plugin": "^1.16.12",
     "husky": "^7.0.4",
     "mocha": "^9.1.3",

package/messages/channel.promote.json

@@ -1,26 +0,0 @@
-{
-  "description": "promote a s3 channel",
-  "summary": "promote a s3 channel",
-  "examples": [
-    "<%= config.bin %> <%= command.id %> --candidate latest-rc --target latest --platform win --platform mac"
-  ],
-  "dryrun": "If true, only show what would happen",
-  "candidate": "the channel name that you want to promote",
-  "target": "the channel name that you are promoting to",
-  "cli": "the cli name to promote",
-  "platform": "the platform to promote",
-  "sha": "the short sha to promote",
-  "maxage": "cache control max-age in seconds",
-  "indexes": "append the promoted urls into the index files",
-  "xz": "also upload xz",
-  "targets": "comma-separated targets to promote (e.g.: linux-arm,win32-x64)",
-  "version": "the version of the candidate to be promoted, which must exist already in s3. Used to fetch the correct sha",
-  "InvalidToken": "This command requires a valid amazon s3 login",
-  "InvalidTag": "the %s channel does not exist in Amazon",
-  "CannotPromoteToSameChannel": "Candidate and target channels cannot the same.",
-  "DryRunMessage": "Dry run results.\nPromoting cli %s version %s commit %s to channel %s for platforms %s",
-  "MissingDependencies": "Missing required environment variables or utilities",
-  "CouldNotDetermineShaAndVersion": "Could not determine sha and version from provided parameters",
-  "CouldNotLocateShaForVersion": "Could locate sha for version \"%s\" in S3",
-  "CouldNotLocateVersionForSha": "Could locate version for sha \"%s\" in S3"
-}

package/messages/circleci.json

@@ -1,32 +0,0 @@
-{
-  "list": {
-    "description": "list known Circle CI slugs from '<%= config.bin %> repositories'",
-    "examples": ["<%= config.bin %> <%= command.id %> -t plugin"],
-    "flags": {
-      "type": "filter based on type of package"
-    }
-  },
-  "envvar": {
-    "update": {
-      "description": "update environment variable(s) on Circle CI slug(s)\nUpdates one or more environment variables on one or more CIrcle CI slugs. The environment variables must already exist on the slug. You will be prompted for the environment variable values unless they already exist on the process. The slugs can be piped in. If so, the environment variables must be on the process (prompting is disabled).",
-      "examples": [
-        "<%= config.bin %> <%= command.id %> -e 'MY_ENV_VAR' -s 'gh/<org>/<repository>'",
-        "echo \"gh/<org>/<repository>\" | <%= config.bin %> <%= command.id %> -e 'MY_ENV_VAR'",
-        "<%= config.bin %> circleci -t plugin | <%= config.bin %> <%= command.id %> -e 'MY_ENV_VAR' -e 'MY_OTHER_ENV_VAR'"
-      ]
-    },
-    "create": {
-      "description": "create environment variable(s) on Circle CI slug(s)\nCreates one or more environment variables on one or more CIrcle CI slugs. The environment variables cannot exist on the slug. You will be prompted for the environment variable values unless they already exist on the process. The slugs can be piped in. If so, the environment variables must be on the process (prompting is disabled).",
-      "examples": [
-        "<%= config.bin %> <%= command.id %> -e 'MY_ENV_VAR' -s 'gh/<org>/<repository>'",
-        "echo \"gh/<org>/<repository>\" | <%= config.bin %> <%= command.id %> -e 'MY_ENV_VAR'",
-        "<%= config.bin %> circleci -t plugin | <%= config.bin %> <%= command.id %> -e 'MY_ENV_VAR' -e 'MY_OTHER_ENV_VAR'"
-      ]
-    },
-    "flags": {
-      "envvar": "a environment variables to set on the given circle slug(s)",
-      "slug": "a circle ci slugs in the format <vcs>/<org name>/<repo name>",
-      "dryrun": "do validation but do not update the environment variable values"
-    }
-  }
-}

package/messages/cli.artifacts.compare.json

@@ -1,12 +0,0 @@
-{
-  "summary": "Look for breaking changes in artifacts (schemas and snapshots) from plugins. Must be run in CLI directory.",
-  "examples": ["<%= config.bin %> <%= command.id %>"],
-  "error.BreakingChanges": "Breaking changes found in artifacts",
-  "flags.plugins.summary": "List of plugins to check for breaking changes.",
-  "flags.previous.summary": "Previous CLI version to compare against. Defaults to the last published version.",
-  "flags.current.summary": "Current CLI version to compare against. Defaults to the version on the CLI in the current directory.",
-  "error.VersionNotFound": "Version not found: %s.",
-  "error.InvalidVersions": "Current version %s must be newer than previous version %s.",
-  "error.InvalidRepo": "This command must be run from the root directory of @salesforce/cli or sfdx-cli.",
-  "error.VersionNotPinned": "Plugin %s is not pinned in package.json."
-}

package/messages/cli.install.test.json

@@ -1,14 +0,0 @@
-{
-  "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"
-  ],
-  "cliFlag": "the cli to install",
-  "methodFlag": "the installation method to use",
-  "channelFlag": "the channel to install from",
-  "outputFileFlag": "the file to write the JSON results to (must be .json)"
-}

package/messages/cli.release.automerge.json

@@ -1,9 +0,0 @@
-{
-  "description": "Attempt to automerge nightly PR",
-  "owner": "Github owner (org), example: salesforcecli",
-  "repo": "Github repo, example: sfdx-cli",
-  "pull-number": "Github pull request number to merge",
-  "dry-run": "Run all checks, but do not merge PR",
-  "verbose": "Show additional debug output",
-  "examples": ["<%= config.bin %> <%= command.id %> --owner salesforcecli --repo sfdx-cli --pul-number 1049"]
-}

package/messages/cli.release.build.json

@@ -1,28 +0,0 @@
-{
-  "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,@sf/config"
-  ],
-  "flags": {
-    "startFromNpmDistTag": "the npm dist-tag to start the release from, examples: nightly, latest-rc",
-    "startFromGithubRef": "a Github ref to start the release from, examples: main, 7.144.0, f476e8e",
-    "releaseChannel": "the channel intended for this release, examples: nightly, latest-rc, latest, dev, beta, etc...",
-    "resolutions": "bump the versions of packages listed in the resolutions section",
-    "pinnedDeps": "bump the versions of the packages listed in the pinnedDependencies section",
-    "jit": "bump the versions of the packages listed in the jitPlugins (just-in-time) section",
-    "label": "add one or more labels to the Github PR",
-    "only": "only bump the version of the packages passed in, uses latest if version is not provided",
-    "patch": "bump the release as a patch of an existing version, not a new minor version",
-    "buildOnly": "only build the release, do not git add/commit/push",
-    "empty": "create an empty release PR for pushing changes to later (version will still be bumped)",
-    "prBaseBranch": "base branch to create the PR against; if not specified, the build determines the branch for you"
-  }
-}

package/messages/cli.releasenotes.json

@@ -1,14 +0,0 @@
-{
-  "description": "pull all relevant information for writing release notes.\n Requires 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"
-  ],
-  "cliFlag": "the cli to pull information for",
-  "sinceFlag": "the version number of the previous release. Defaults to the latest-rc version on npm",
-  "markdownFlag": "format the output in markdown"
-}

package/messages/cli.schemas.collect.json

@@ -1,4 +0,0 @@
-{
-  "description": "collect schemas from installed plugins",
-  "examples": ["<%= config.bin %> <%= command.id %>"]
-}

package/messages/cli.schemas.compare.json

@@ -1,4 +0,0 @@
-{
-  "description": "compare schemas from installed plugins",
-  "examples": ["<%= config.bin %> <%= command.id %>"]
-}

package/messages/cli.tarballs.prepare.json

@@ -1,7 +0,0 @@
-{
-  "description": "remove unnecessary files from node_modules",
-  "dryrun": "only show what would be removed from node_modules",
-  "verbose": "show all files paths being removed",
-  "types": "remove all types (.d.ts) files from node_modules ",
-  "examples": ["<%= config.bin %> <%= command.id %>"]
-}

package/messages/cli.tarballs.smoke.json

@@ -1,5 +0,0 @@
-{
-  "description": "smoke tests for the sf CLI\n Tests that the CLI and every command can be initialized.",
-  "examples": ["<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %>"],
-  "verboseFlag": "show the --help output for each command"
-}

package/messages/cli.tarballs.verify.json

@@ -1,10 +0,0 @@
-{
-  "description": "verify that tarballs are ready to be uploaded",
-  "cli": "the cli to verify",
-  "windowsUsernameBuffer": "the number of characters to allow for windows usernames",
-  "examples": [
-    "<%= config.bin %> <%= command.id %>",
-    "<%= config.bin %> <%= command.id %> --cli sfdx",
-    "<%= config.bin %> <%= command.id %> --cli sf"
-  ]
-}

package/messages/cli.versions.inspect.json

@@ -1,20 +0,0 @@
-{
-  "description": "inspect the CLI version across all install paths",
-  "deps": "glob pattern of dependencies you want to see the version of",
-  "salesforce": "show versions of salesforce owned dependencies",
-  "channels": "the channel you want to inspect (for achives, latest and latest-rc are translated to stable and stable-rc. And vice-versa for npm)",
-  "locations": "the location you want to inspect",
-  "cli": "the CLI you want to inspect",
-  "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"
-  ]
-}

package/messages/dependabot.automerge.json

@@ -1,10 +0,0 @@
-{
-  "description": "automatically merge one green, mergeable PR up to the specified maximum bump type",
-  "skipCi": "add [skip ci] to the merge commit title",
-  "mergeMethod": "merge method to use",
-  "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"
-  ]
-}

package/messages/dependabot.consolidate.json

@@ -1,16 +0,0 @@
-{
-  "description": "consolidate dependabot PRs into a single PR",
-  "maxVersionBump": "the maximum version bump you want to be included",
-  "dryrun": "only show what would happen if you consolidated dependabot PRs",
-  "baseBranch": "name of the base branch for merging",
-  "targetBranch": "name of the target branch for merging",
-  "noPR": "do everything but create the PR",
-  "ignore": "ignore any PRs with titles that include this value",
-  "owner": "the organization that the repository belongs to. This defaults to the owner specified in the package.json",
-  "repo": "the repository you want to consolidate PRs on. This defaults to the repository specified in the package.json",
-  "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"
-  ]
-}

package/messages/messages.json

@@ -1,22 +0,0 @@
-{
-  "HelpDefaults": "If not supplied, the apiversion, template, and outputdir use default values.\n",
-  "HelpOutputDirRelative": "The outputdir can be an absolute path or relative to the current working directory.\n",
-  "HelpOutputDirRelativeLightning": "If you don’t specify an outputdir, we create a subfolder in your current working directory with the name of your bundle. For example, if the current working directory is force-app and your Lightning bundle is called myBundle, we create force-app/myBundle/ to store the files in the bundle.\n",
-  "HelpExamplesTitle": "\nExamples:\n",
-  "OutputDirFlagDescription": "folder for saving the created files",
-  "OutputDirFlagLongDescription": "The directory to store the newly created files. The location can be an absolute path or relative to the current working directory. The default is the current directory.",
-  "TemplateFlagDescription": "template to use for file creation",
-  "TemplateFlagLongDescription": "The template to use to create the file. Supplied parameter values or default values are filled into a copy of the template.",
-  "TargetDirOutput": "target dir = %s",
-  "App": "app",
-  "Event": "event",
-  "Interface": "interface",
-  "Test": "test",
-  "Component": "component",
-  "Page": "page",
-
-  "AlphaNumericNameError": "Name must contain only alphanumeric characters.",
-  "NameMustStartWithLetterError": "Name must start with a letter.",
-  "EndWithUnderscoreError": "Name can't end with an underscore.",
-  "DoubleUnderscoreError": "Name can't contain 2 consecutive underscores."
-}

package/messages/npm.dependencies.pin.json

@@ -1,7 +0,0 @@
-{
-  "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": {
-    "tag": "The name of the tag you want, e.g. 'latest-rc', or 'latest'",
-    "dryrun": "If true, will not make any changes to the package.json"
-  }
-}

package/messages/npm.package.promote.json

@@ -1,9 +0,0 @@
-{
-  "description": "promote an npm package",
-  "examples": ["<%= config.bin %> <%= command.id %> --candidate latest-rc --target latest"],
-  "dryrun": "If true, only show what would happen",
-  "candidate": "the npm tag that you want to promote",
-  "target": "the npm tag that you are promoting to",
-  "InvalidToken": "This command requries an npm publish token.",
-  "InvalidTag": "the %s tag does not exist in npm."
-}

package/messages/npm.package.release.json

@@ -1,13 +0,0 @@
-{
-  "description": "publish npm package",
-  "dryrun": "If true, will not commit changes to repo or push any tags",
-  "sign": "If true, then the package will be signed and the signature will be uploaded to S3",
-  "npmTag": "tag to use when publishing to npm",
-  "npmAccess": "access level to use when publishing to npm",
-  "install": "run yarn install and build on repository",
-  "githubtag": "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",
-  "prerelease": "determine the next version as <version>-<prerelease>.0 if version is not manually set",
-  "verify": "verify npm registry has new version after publish and digital signature",
-  "InvalidNextVersion": "%s already exists in the public npm registry",
-  "MissingDependencies": "Missing requred environment variables or utilites"
-}

package/messages/repositories.json

@@ -1,7 +0,0 @@
-{
-  "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"
-  ]
-}

package/messages/trust.sign.json

@@ -1,8 +0,0 @@
-{
-  "description": "pack an npm package and produce a tgz file along with a corresponding digital signature",
-  "signatureUrl": "the url location where the signature will be hosted minus the name of the actual signature file.",
-  "publicKeyUrl": "the url where the public key/certificate will be hosted.",
-  "privateKeyPath": "the local file path for the private key.",
-  "target": "the package path you want to target for signing. Defaults to the current working directory.",
-  "tarPath": "specify the package tgz path to sign instead of generating one from the target package"
-}

package/messages/trust.upload.json

@@ -1,7 +0,0 @@
-{
-  "description": "upload signature to S3. Requires AWS_SECRET_ACCESS_KEY and AWS_ACCESS_KEY_ID to be set in the environment",
-  "signature": "path to .sig file you want to upload to S3",
-  "bucket": "name of S3 bucket",
-  "keyPrefix": "prefix to add to S3 key",
-  "MissingAwsEnVars": "AWS_SECRET_ACCESS_KEY and AWS_ACCESS_KEY_ID are required to be set in the environment"
-}

package/messages/typescript.update.json

@@ -1,7 +0,0 @@
-{
-  "description": "Runs tests with updated typescript version and ES target",
-  "typescriptVersion": "Specify the typescript version you'd like to update to. Defaults to latest if not specified",
-  "esTarget": "Specify the ES target you'd like to use. Defaults to ESNext if not specified",
-  "InvalidTypescriptVersion": "typescript version %s does not exist",
-  "InvalidTargetVersion": "Invalid ES target: %s."
-}