Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion command-guide/advanced/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ FLAGS
-n, --releasename=<value> (required) Name of the release for which to generate changelog
-w, --workitemfilter=<value> (required) Regular expression used to search for work items (user stories) introduced in
release
--directory=<value> Relative path to directory to which the release defintion file should be generated, if
--directory=<value> Relative path to directory to which the release definition file should be generated, if
the directory doesnt exist, it will be created
--limit=<value> limit the number of releases to display in changelog markdown
--loglevel=<option> [default: info] logging level for this command invocation
Expand Down
2 changes: 1 addition & 1 deletion command-guide/advanced/repo.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ FLAGS
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, --releasedefinitions=<value>... (required) Path to release definiton yaml
-p, --releasedefinitions=<value>... (required) Path to release definition yaml
-s, --sourcebranchname=<value> (required) Name of the source branch to be used on which the alignment need to be
applied
-t, --targetbranchname=<value> (required) Name of the target branch to be created after the alignment
Expand Down
2 changes: 1 addition & 1 deletion command-guide/core/release.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ FLAGS
-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
-p, --releasedefinition=<value>... (required) Path to release definition 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.
Expand Down
2 changes: 1 addition & 1 deletion configuring-a-project/release-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ The below table list the options that are currently available for release config

<table><thead><tr><th>Parameter</th><th>Required</th><th width="134">Type</th><th>Description</th></tr></thead><tbody><tr><td>releaseName</td><td>No</td><td>String</td><td>Name of the release config, in flxbl project, this name is used as the name of the domain</td></tr><tr><td>pool</td><td>No</td><td>String</td><td>Name of the scratch org or sandbox pool associated with this release config during validation</td></tr><tr><td>excludeArtifacts</td><td>No</td><td>Array</td><td>An array of artifacts that need to be excluded while creating the release definition</td></tr><tr><td>includeOnlyArtifacts</td><td>No</td><td>Array</td><td>An array of artifacts that should only be included while creating the release definition</td></tr><tr><td>dependencyOn</td><td>No</td><td>Array</td><td>An array of packages that denotes the dependency this configuration has. The dependencies mentioned will be used for synchronization in review sandboxes</td></tr><tr><td>excludePackageDependencies</td><td>No</td><td>Array</td><td>Exclude the mentioned package dependencies from the release definition</td></tr><tr><td>includeOnlyPackageDependencies</td><td>No</td><td>Array</td><td>Include only the mentioned package dependencies from the release definition</td></tr><tr><td>releasedefinitionProperties</td><td>No</td><td>Object</td><td>Properties of release definition that should be added to the generated release definition. See below</td></tr></tbody></table>

A release configuration also can contain additional options that can be used by certain sfp commands to generate [release definitions](../releasing-artifacts/release-definitions.md). These properties in a release definiton alters the behaviour of deployment of artifacts during a release
A release configuration also can contain additional options that can be used by certain sfp commands to generate [release definitions](../releasing-artifacts/release-definitions.md). These properties in a release definition alters the behaviour of deployment of artifacts during a release



Expand Down
2 changes: 1 addition & 1 deletion releasing-artifacts/release-definitions.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ changelog:
limit: 30
```

Lets examine closely the above release defintion file and understand the various attributes and it purposes
Lets examine closely the above release definition file and understand the various attributes and it purposes

```
release: Sprint-2-13-11-6844956242
Expand Down