@flxbl-io/sfp release
Release a set of artifact(s) as defined by a release definition into a target org
@flxbl-io/sfp release
@flxbl-io/sfp release
Release a set of artifact(s) as defined by a release definition into a target org
USAGE
$ @flxbl-io/sfp release -p <value> -o <value> [--scope <value> [--npm | -f <value>]] [--npmrcpath <value> ]
[-g <value>] [-t <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
-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, --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
--scope=<value> (required for NPM) User or Organisation scope of the NPM package
--waittime=<value> [default: 120] Wait time for package installation
DESCRIPTION
Release a set of artifact(s) as defined by a release definition into a target org
ALIASES
$ @flxbl-io/sfp orchestrator release
EXAMPLES
sfp release -p path/to/releasedefinition.yml -u myorg --npm --scope myscope --generatechangelog
See code: src/commands/release.ts
@flxbl-io/sfp quickbuild
Build artifact(s) of your packages in the current project without dependency validation for unlocked packages
@flxbl-io/sfp quickbuild
@flxbl-io/sfp quickbuild
Build artifact(s) of your packages in the current project without dependency validation for unlocked packages
USAGE
$ @flxbl-io/sfp quickbuild -v <value> --branch <value> [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] [--apiversion <value>] [--diffcheck] [-p
<value>] [-r <value>] [-f <value>] [--artifactdir <value>] [--waittime <value>] [--buildnumber <value>]
[--executorcount <value>] [--tag <value>] [--releaseconfig <value>]
FLAGS
-f, --configfilepath=<value> [default: config/project-scratch-def.json] Path in the current project directory
containing config file for the packaging org
-p, --buildOnly=<value>... Only build artifacts for the provided package names,use comma separated list of
package names if there are multiple packages
-r, --repourl=<value> Custom source repository URL to use in artifact metadata, overrides origin URL defined
in git config
-v, --devhubalias=<value> (required) Username or alias of the Dev Hub org.
--apiversion=<value> Override the api version used for api requests made by this command
--artifactdir=<value> [default: artifacts] The directory where the generated artifact is to be written
--branch=<value> (required) [default: main] The git branch that this build is triggered on, Useful for
metrics and general identification purposes
--buildnumber=<value> [default: 1] The build number to be used for source packages, Unlocked Packages will
be assigned the buildnumber from Salesforce directly if using .NEXT
--diffcheck Only build the packages which have changed by analyzing previous tags
--executorcount=<value> [default: 5] Number of parallel package task schedulors
--loglevel=<option> [default: info] logging level for this command invocation
<options: trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL>
--releaseconfig=<value>... Path to the release config file(s) to limit packages built by domains
--tag=<value> Tag the build with a label, useful to identify in metrics
--waittime=<value> [default: 120] Wait time for command to finish in minutes
DESCRIPTION
Build artifact(s) of your packages in the current project without dependency validation for unlocked packages
ALIASES
$ @flxbl-io/sfp orchestrator quickbuild
See code: src/commands/quickbuild.ts
@flxbl-io/sfp publish
Publish packages to a NPM Compatible artifact registry
@flxbl-io/sfp publish
@flxbl-io/sfp publish
Publish packages to a NPM Compatible artifact registry
USAGE
$ @flxbl-io/sfp publish -d <value> [-p -v <value>] [-t <value>] [--gittag] [--gittaglimit <value>]
[--gittagage <value>] [--pushgittag] [--scope <value> [--npm | -f <value>]] [--npmtag <value> ] [--npmrcpath <value>
] [-g <value>] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
FLAGS
-d, --artifactdir=<value> (required) [default: artifacts] The directory containing artifacts to be published
-f, --scriptpath=<value> Path to script that authenticates and uploaded artifacts to 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.
-p, --publishpromotedonly Only publish unlocked packages that have been promoted
-t, --tag=<value> Tag the publish with a label, useful for identification in metrics
-v, --devhubalias=<value> Username or alias of the Dev Hub org.
--gittag Tag the current commit ID with an annotated tag containing the package name and
version - does not push tag
--gittagage=<value> Specifies the number of days,for a tag to be retained,any tags older the provided
number will be deleted
--gittaglimit=<value> Specifies the minimum number of tags to be retained for a package
--loglevel=<option> [default: info] logging level for this command invocation
<options: trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL>
--npm Upload artifacts to a pre-authenticated private npm registry
--npmrcpath=<value> Path to .npmrc file used for authentication to registry. If left blank, defaults to
home directory
--npmtag=<value> Add an optional distribution tag to NPM packages. If not provided, the 'latest' tag
is set to the published version.
--pushgittag Pushes the git tags created by this command to the repo, ensure you have access to
the repo
--scope=<value> (required for NPM) User or Organisation scope of the NPM package
DESCRIPTION
Publish packages to a NPM Compatible artifact registry
ALIASES
$ @flxbl-io/sfp orchestrator publish
EXAMPLES
$ sfp publish --npm
See code: src/commands/publish.ts
@flxbl-io/sfp install
Installs artifact(s) from a given directory to a target org
@flxbl-io/sfp install
@flxbl-io/sfp install
Installs artifact(s) from a given directory to a target org
USAGE
$ @flxbl-io/sfp install -o <value> [--artifactdir <value>] [--waittime <value>] [-t <value>] [-b <value>
--skipifalreadyed] [-p <value>] [--releaseconfig <value>] [--enablesourcetracking] [-g <value>] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
FLAGS
-b, --baselineorg=<value> The org against which the package skip should be baselined
-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, --artifacts=<value>... Only install artifacts for the provided packages, use comma separated list of
package names if there are multiple packages
-t, --tag=<value> Tag the deploy with a label, useful for identification in metrics
--artifactdir=<value> [default: artifacts] The directory containing artifacts to be deployed
--enablesourcetracking Enable source tracking on the packages being deployed to an org
--loglevel=<option> [default: info] logging level for this command invocation
<options: trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL>
--releaseconfig=<value> Path to the config file which determines how the packages are deployed based on the
filters in release config
--skipifalreadyinstalled Skip the package installation if the package is already installed in the org
--waittime=<value> [default: 120] Wait time for command to finish in minutes
DESCRIPTION
Installs artifact(s) from a given directory to a target org
ALIASES
$ @flxbl-io/sfp orchestrator deploy
$ @flxbl-io/sfp deploy
EXAMPLES
$ sfp install -o <username>
See code: src/commands/install.ts
@flxbl-io/sfp build
Build artifact(s) of your packages in the current project
@flxbl-io/sfp build
@flxbl-io/sfp build
Build artifact(s) of your packages in the current project
USAGE
$ @flxbl-io/sfp build -v <value> --branch <value> [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] [--apiversion <value>] [--diffcheck] [-p
<value>] [-r <value>] [-f <value>] [--artifactdir <value>] [--waittime <value>] [--number <value>] [--executorcount
<value>] [--tag <value>] [--releaseconfig <value>]
FLAGS
-f, --configfilepath=<value> [default: config/project-scratch-def.json] Path in the current project directory
containing config file for the packaging org
-p, --buildOnly=<value>... Only build artifacts for the provided package names,use comma separated list of
package names if there are multiple packages
-r, --repourl=<value> Custom source repository URL to use in artifact metadata, overrides origin URL defined
in git config
-v, --devhubalias=<value> (required) Username or alias of the Dev Hub org.
--apiversion=<value> Override the api version used for api requests made by this command
--artifactdir=<value> [default: artifacts] The directory where the generated artifact is to be written
--branch=<value> (required) [default: main] The git branch that this build is triggered on, Useful for
metrics and general identification purposes
--buildnumber=<value> [default: 1] The build number to be used for source packages, Unlocked Packages will
be assigned the buildnumber from Salesforce directly if using .NEXT
--diffcheck Only build the packages which have changed by analyzing previous tags
--executorcount=<value> [default: 5] Number of parallel package task schedulors
--loglevel=<option> [default: info] logging level for this command invocation
<options: trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL>
--releaseconfig=<value>... Path to the release config file(s) to limit packages built by domains
--tag=<value> Tag the build with a label, useful to identify in metrics
--waittime=<value> [default: 120] Wait time for command to finish in minutes
DESCRIPTION
Build artifact(s) of your packages in the current project
ALIASES
$ @flxbl-io/sfp orchestrator build
See code: src/commands/build.ts