@salesforce/plugin-release-management 4.4.18 → 4.4.20

package/messages/channel.promote.md

@@ -0,0 +1,84 @@
+# description
+
+promote a s3 channel
+
+# summary
+
+promote a s3 channel
+
+# examples
+
+- <%= config.bin %> <%= command.id %> --candidate latest-rc --target latest --platform win --platform mac
+
+# flags.dryrun.summary
+
+If true, only show what would happen
+
+# flags.promote-from-channel.summary
+
+the channel name that you want to promote
+
+# flags.promote-to-channel.summary
+
+the channel name that you are promoting to
+
+# flags.cli.summary
+
+the cli name to promote
+
+# flags.platform.summary
+
+the platform to promote
+
+# flags.sha.summary
+
+the short sha to promote
+
+# flags.max-age.summary
+
+cache control max-age in seconds
+
+# flags.indexes.summary
+
+append the promoted urls into the index files
+
+# flags.xz.summary
+
+also upload xz
+
+# targets
+
+comma-separated targets to promote (e.g.: linux-arm,win32-x64)
+
+# flags.version.summary
+
+the version of the candidate to be promoted, which must exist already in s3. Used to fetch the correct sha
+
+# InvalidTag
+
+the %s channel does not exist in Amazon
+
+# CannotPromoteToSameChannel
+
+Candidate and target channels cannot the same.
+
+# DryRunMessage
+
+Dry run results.
+Promoting 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/cli.artifacts.compare.md

@@ -0,0 +1,39 @@
+# 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.plugin.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.md

@@ -0,0 +1,31 @@
+# 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.cli.summary
+
+the cli to install
+
+# flags.method.summary
+
+the installation method to use
+
+# flags.channel.summary
+
+the channel to install from
+
+# flags.output-file.summary
+
+the file to write the JSON results to (must be .json)

package/messages/cli.release.automerge.md

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

package/messages/cli.release.build.md

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

package/messages/cli.releasenotes.md

@@ -0,0 +1,30 @@
+# description
+
+pull all relevant information for writing release notes.
+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
+
+# flags.cli.summary
+
+the cli to pull information for
+
+# flags.since.summary
+
+the version number of the previous release. Defaults to the latest-rc version on npm
+
+# flags.markdown.summary
+
+format the output in markdown

package/messages/cli.schemas.compare.md

@@ -0,0 +1,7 @@
+# description
+
+compare schemas from installed plugins
+
+# examples
+
+- <%= config.bin %> <%= command.id %>

package/messages/cli.tarballs.prepare.md

@@ -0,0 +1,19 @@
+# description
+
+remove unnecessary files from node_modules
+
+# flags.dryrun.summary
+
+only show what would be removed from node_modules
+
+# flags.verbose.summary
+
+show all files paths being removed
+
+# flags.types.summary
+
+remove all types (.d.ts) files from node_modules
+
+# examples
+
+- <%= config.bin %> <%= command.id %>

package/messages/cli.tarballs.smoke.md

@@ -0,0 +1,14 @@
+# description
+
+smoke tests for the sf CLI
+Tests that the CLI and every command can be initialized.
+
+# examples
+
+- <%= config.bin %> <%= command.id %>
+
+- <%= config.bin %> <%= command.id %>
+
+# flags.verbose.summary
+
+show the --help output for each command

package/messages/cli.tarballs.verify.md

@@ -0,0 +1,19 @@
+# description
+
+verify that tarballs are ready to be uploaded
+
+# cli
+
+the cli to verify
+
+# flags.windows-username-buffer.summary
+
+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.md

@@ -0,0 +1,45 @@
+# description
+
+inspect the CLI version across all install paths
+
+# flags.dependencies.summary
+
+glob pattern of dependencies you want to see the version of
+
+# flags.salesforce.summary
+
+show versions of salesforce owned dependencies
+
+# flags.channels.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)
+
+# flags.locations.summary
+
+the location you want to inspect
+
+# flags.cli.summary
+
+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.md

@@ -0,0 +1,19 @@
+# description
+
+automatically merge one green, mergeable PR up to the specified maximum bump type
+
+# flags.skip-ci.summary
+
+add [skip ci] to the merge commit title
+
+# flags.merge-method.summary
+
+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.md

@@ -0,0 +1,43 @@
+# 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/github.check.closed.md

@@ -14,10 +14,10 @@ Description of a flag.
 
 - <%= config.bin %> <%= command.id %> -o me@gus.com
 
-# flags.gus
+# flags.gus.summary
 
 Username/alias of your GUS org connection
 
-# flags.github-token
+# flags.github-token.summary
 
 Github token--store this in the environment as GITHUB_TOKEN

package/messages/npm.dependencies.pin.md

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

package/messages/npm.package.promote.md

@@ -0,0 +1,23 @@
+# 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
+
+# InvalidTag
+
+the %s tag does not exist in npm.

package/messages/npm.package.release.md

@@ -0,0 +1,43 @@
+# description
+
+publish npm package
+
+# flags.dryrun.summary
+
+If true, will not commit changes to repo or push any tags
+
+# flags.sign.summary
+
+If true, then the package will be signed and the signature will be uploaded to S3
+
+# flags.npmtag.summary
+
+tag to use when publishing to npm
+
+# flags.npmaccess.summary
+
+access level to use when publishing to npm
+
+# flags.install.summary
+
+run yarn install and build on repository
+
+# flags.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
+
+# flags.prerelease.summary
+
+determine the next version as <version>-<prerelease>.0 if version is not manually set
+
+# flags.verify.summary
+
+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 utilities

package/messages/repositories.md

@@ -0,0 +1,10 @@
+# description
+
+list repositories owned and supported by Salesforce CLI
+For 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