Release
sfp release
sfp releaseUSAGE
$ sfp release -p <value>... -o <value> [--json] [--repository <value>] [-e <value>] [-t <value>]
[--sfp-server-url <value>] [--scope <value> [--npm | -f <value>]] [--npmrcpath <value> ] [-g <value>...] [-t
<value>] [--replacementsoverride <value>] [--waittime <value>] [--keys <value>] [-d <value>] [-b <value>
--generatechangelog] [-v <value>] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
FLAGS
-b, --branchname=<value> Repository branch in which the changelog files are located
-d, --directory=<value> Relative path to directory to which the changelog should be generated, if the
directory doesnt exist, it will be created
-e, --email=<value> [env: SFP_SERVER_USER] Email address for authenticated user. Ignored if
--application-token is provided.
-f, --scriptpath=<value> (Optional: no-NPM) Path to script that authenticates and downloads artifacts from
the registry
-g, --logsgroupsymbol=<value>... Symbol used by CICD platform to group/collapse logs in the console. Provide an
opening group, and an optional closing group symbol.
-o, --targetorg=<value> (required) Username or alias of the target org.
-p, --releasedefinition=<value>... (required) Path to release definiton yaml, Multiple paths can be seperated by
commas
-t, --application-token=<value> [env: SFP_SERVER_TOKEN] Application token for CI/CD authentication. Takes
precedence over --email.
-t, --tag=<value> Tag the release with a label, useful for identification in metrics
-v, --devhubalias=<value> Username or alias of the Dev Hub org.
--generatechangelog Create a release changelog
--keys=<value> Keys to be used while installing any managed package dependencies. Required format
is a string of key-value pairs separated by spaces e.g. packageA:pw123
packageB:pw123 packageC:pw123
--loglevel=<option> [default: info] logging level for this command invocation
<options: trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL>
--npm Download artifacts from a pre-authenticated private npm registry
--npmrcpath=<value> Path to .npmrc file used for authentication to registry. If left blank, defaults
to home directory
--replacementsoverride=<value> Path to a YAML file containing replacement overrides to apply during deployment
--repository=<value> The repository identifier. E.g `owner/repo`
--scope=<value> (required for NPM) User or Organisation scope of the NPM package
--sfp-server-url=<value> [env: SFP_SERVER_URL] URL of the SFP server. Can be set via environment variable
`SFP_SERVER_URL` or config: sfp config:set server-url
--waittime=<value> [default: 120] Wait time for package installation
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Release a set of artifact(s) as defined by a release definition into a target org
EXAMPLES
$ sfp release -p path/to/releasedefinition.yml -u myorg --npm --scope myscope --generatechangelogLast updated
Was this helpful?