Skip to content

Commit 0d5b32a

Browse files
committed
chore(release): 3.8.0 [skip ci]
1 parent 014500e commit 0d5b32a

File tree

3 files changed

+82
-18
lines changed

3 files changed

+82
-18
lines changed

CHANGELOG.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
# [3.8.0](https://github.com/salesforcecli/plugin-deploy-retrieve/compare/3.7.10...3.8.0) (2024-05-29)
2+
3+
### Features
4+
5+
- convert project to use a new source behavior ([#1015](https://github.com/salesforcecli/plugin-deploy-retrieve/issues/1015)) ([014500e](https://github.com/salesforcecli/plugin-deploy-retrieve/commit/014500e2387b07cfbf7b07339a98c06e81f0e2dd)), closes [#1018](https://github.com/salesforcecli/plugin-deploy-retrieve/issues/1018)
6+
17
## [3.7.10](https://github.com/salesforcecli/plugin-deploy-retrieve/compare/3.7.9...3.7.10) (2024-05-28)
28

39
### Bug Fixes

README.md

Lines changed: 75 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@ sf plugins
6464

6565
- [`sf project convert mdapi`](#sf-project-convert-mdapi)
6666
- [`sf project convert source`](#sf-project-convert-source)
67+
- [`sf project convert source-behavior`](#sf-project-convert-source-behavior)
6768
- [`sf project delete source`](#sf-project-delete-source)
6869
- [`sf project delete tracking`](#sf-project-delete-tracking)
6970
- [`sf project deploy cancel`](#sf-project-deploy-cancel)
@@ -140,7 +141,7 @@ FLAG DESCRIPTIONS
140141
If you specify this parameter, don’t specify --metadata or --source-dir.
141142
```
142143

143-
_See code: [src/commands/project/convert/mdapi.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.10/src/commands/project/convert/mdapi.ts)_
144+
_See code: [src/commands/project/convert/mdapi.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.0/src/commands/project/convert/mdapi.ts)_
144145

145146
## `sf project convert source`
146147

@@ -152,7 +153,7 @@ USAGE
152153
[-p <value> | -x <value> | -m <value>]
153154
154155
FLAGS
155-
-d, --output-dir=<value> [default: metadataPackage_1716916326517] Output directory to store the Metadata
156+
-d, --output-dir=<value> [default: metadataPackage_1716992749510] Output directory to store the Metadata
156157
API–formatted files in.
157158
-m, --metadata=<value>... Metadata component names to convert.
158159
-n, --package-name=<value> Name of the package to associate with the metadata-formatted files.
@@ -213,7 +214,64 @@ FLAG DESCRIPTIONS
213214
Override the api version used for api requests made by this command
214215
```
215216

216-
_See code: [src/commands/project/convert/source.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.10/src/commands/project/convert/source.ts)_
217+
_See code: [src/commands/project/convert/source.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.0/src/commands/project/convert/source.ts)_
218+
219+
## `sf project convert source-behavior`
220+
221+
Enable a behavior of your project source files, and then update your Salesforce DX project to implement the behavior.
222+
223+
```
224+
USAGE
225+
$ sf project convert source-behavior -b
226+
decomposeCustomLabelsBeta|decomposePermissionSetBeta|decomposeSharingRulesBeta|decomposeWorkflowBeta [--json]
227+
[--flags-dir <value>] [--dry-run] [--preserve-temp-dir] [-o <value>]
228+
229+
FLAGS
230+
-b, --behavior=<option> (required) Behavior to enable; the values correspond to the possible values of the
231+
"sourceBehaviorOption" option in the "sfdx-project.json" file.
232+
<options: decomposeCustomLabelsBeta|decomposePermissionSetBeta|decomposeSharingRulesBeta|dec
233+
omposeWorkflowBeta>
234+
-o, --target-org=<value>
235+
--dry-run Display what the command would do, but don't make any actual changes.
236+
--preserve-temp-dir Don't delete the metadata API format temporary directory that this command creates. Useful
237+
for debugging.
238+
239+
GLOBAL FLAGS
240+
--flags-dir=<value> Import flag values from a directory.
241+
--json Format output as json.
242+
243+
DESCRIPTION
244+
Enable a behavior of your project source files, and then update your Salesforce DX project to implement the behavior.
245+
246+
Specifically, this command updates the "sourceBehaviorOption" option in the "sfdx-project.json" file and then converts
247+
the associated local source files in your project as needed.
248+
249+
For example, run this command with the "--behavior decomposePermissionSetBeta" flag to start decomposing permission
250+
sets when you deploy or retrieve them. Decomposing means breaking up the monolithic metadata API format XML file that
251+
corresponds to a metadata component into smaller XML files and directories based on its subtypes. Permission sets are
252+
not decomposed by default; you must opt-in to start decomposing them by using this command. When the command finishes,
253+
your "sfdx-project.json" file is updated to always decompose permission sets, and the existing permission set files in
254+
your local package directories are converted into the new decomposed format. You run this command only once for a
255+
given behavior change.
256+
257+
For more information about the possible values for the --behavior flag, see the "sourceBehaviorOptions" section in the
258+
https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_ws_config.htm topic.
259+
260+
EXAMPLES
261+
Update your Salesforce DX project to decompose custom labels:
262+
263+
$ sf project convert source-behavior --behavior decomposeCustomLabelsBeta
264+
265+
Display what the command would do, but don't change any existing files:
266+
267+
$ sf project convert source-behavior --behavior decomposeCustomLabelsBeta --dry-run
268+
269+
Keep the temporary directory that contains the interim metadata API formatted files:
270+
271+
$ sf project convert source-behavior --behavior decomposeCustomLabelsBeta --dry-run --preserve-temp-dir
272+
```
273+
274+
_See code: [src/commands/project/convert/source-behavior.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.0/src/commands/project/convert/source-behavior.ts)_
217275

218276
## `sf project delete source`
219277

@@ -353,7 +411,7 @@ FLAG DESCRIPTIONS
353411
- Separate the test names with spaces: --tests Test1 Test2 "Test With Space"
354412
```
355413

356-
_See code: [src/commands/project/delete/source.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.10/src/commands/project/delete/source.ts)_
414+
_See code: [src/commands/project/delete/source.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.0/src/commands/project/delete/source.ts)_
357415

358416
## `sf project delete tracking`
359417

@@ -390,7 +448,7 @@ EXAMPLES
390448
$ sf project delete tracking --target-org my-scratch
391449
```
392450

393-
_See code: [src/commands/project/delete/tracking.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.10/src/commands/project/delete/tracking.ts)_
451+
_See code: [src/commands/project/delete/tracking.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.0/src/commands/project/delete/tracking.ts)_
394452

395453
## `sf project deploy cancel`
396454

@@ -466,7 +524,7 @@ FLAG DESCRIPTIONS
466524
project deploy report".
467525
```
468526

469-
_See code: [src/commands/project/deploy/cancel.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.10/src/commands/project/deploy/cancel.ts)_
527+
_See code: [src/commands/project/deploy/cancel.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.0/src/commands/project/deploy/cancel.ts)_
470528

471529
## `sf project deploy preview`
472530

@@ -552,7 +610,7 @@ FLAG DESCRIPTIONS
552610
All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.
553611
```
554612

555-
_See code: [src/commands/project/deploy/preview.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.10/src/commands/project/deploy/preview.ts)_
613+
_See code: [src/commands/project/deploy/preview.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.0/src/commands/project/deploy/preview.ts)_
556614

557615
## `sf project deploy quick`
558616

@@ -640,7 +698,7 @@ FLAG DESCRIPTIONS
640698
deploy report".
641699
```
642700

643-
_See code: [src/commands/project/deploy/quick.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.10/src/commands/project/deploy/quick.ts)_
701+
_See code: [src/commands/project/deploy/quick.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.0/src/commands/project/deploy/quick.ts)_
644702

645703
## `sf project deploy report`
646704

@@ -736,7 +794,7 @@ FLAG DESCRIPTIONS
736794
--coverage-formatters lcov --coverage-formatters clover
737795
```
738796

739-
_See code: [src/commands/project/deploy/report.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.10/src/commands/project/deploy/report.ts)_
797+
_See code: [src/commands/project/deploy/report.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.0/src/commands/project/deploy/report.ts)_
740798

741799
## `sf project deploy resume`
742800

@@ -821,7 +879,7 @@ FLAG DESCRIPTIONS
821879
--coverage-formatters lcov --coverage-formatters clover
822880
```
823881

824-
_See code: [src/commands/project/deploy/resume.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.10/src/commands/project/deploy/resume.ts)_
882+
_See code: [src/commands/project/deploy/resume.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.0/src/commands/project/deploy/resume.ts)_
825883

826884
## `sf project deploy start`
827885

@@ -1042,7 +1100,7 @@ FLAG DESCRIPTIONS
10421100
--coverage-formatters lcov --coverage-formatters clover
10431101
```
10441102

1045-
_See code: [src/commands/project/deploy/start.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.10/src/commands/project/deploy/start.ts)_
1103+
_See code: [src/commands/project/deploy/start.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.0/src/commands/project/deploy/start.ts)_
10461104

10471105
## `sf project deploy validate`
10481106

@@ -1217,7 +1275,7 @@ FLAG DESCRIPTIONS
12171275
--coverage-formatters lcov --coverage-formatters clover
12181276
```
12191277

1220-
_See code: [src/commands/project/deploy/validate.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.10/src/commands/project/deploy/validate.ts)_
1278+
_See code: [src/commands/project/deploy/validate.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.0/src/commands/project/deploy/validate.ts)_
12211279

12221280
## `sf project generate manifest`
12231281

@@ -1294,7 +1352,7 @@ EXAMPLES
12941352
$ sf project generate manifest --from-org [email protected] --include-packages unlocked
12951353
```
12961354

1297-
_See code: [src/commands/project/generate/manifest.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.10/src/commands/project/generate/manifest.ts)_
1355+
_See code: [src/commands/project/generate/manifest.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.0/src/commands/project/generate/manifest.ts)_
12981356

12991357
## `sf project list ignored`
13001358

@@ -1336,7 +1394,7 @@ EXAMPLES
13361394
$ sf project list ignored --source-dir package.xml
13371395
```
13381396

1339-
_See code: [src/commands/project/list/ignored.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.10/src/commands/project/list/ignored.ts)_
1397+
_See code: [src/commands/project/list/ignored.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.0/src/commands/project/list/ignored.ts)_
13401398

13411399
## `sf project reset tracking`
13421400

@@ -1385,7 +1443,7 @@ EXAMPLES
13851443
$ sf project reset tracking --revision 30
13861444
```
13871445

1388-
_See code: [src/commands/project/reset/tracking.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.10/src/commands/project/reset/tracking.ts)_
1446+
_See code: [src/commands/project/reset/tracking.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.0/src/commands/project/reset/tracking.ts)_
13891447

13901448
## `sf project retrieve preview`
13911449

@@ -1442,7 +1500,7 @@ FLAG DESCRIPTIONS
14421500
Overrides your default org.
14431501
```
14441502

1445-
_See code: [src/commands/project/retrieve/preview.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.10/src/commands/project/retrieve/preview.ts)_
1503+
_See code: [src/commands/project/retrieve/preview.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.0/src/commands/project/retrieve/preview.ts)_
14461504

14471505
## `sf project retrieve start`
14481506

@@ -1593,6 +1651,6 @@ FLAG DESCRIPTIONS
15931651
If you specify this parameter, don’t specify --metadata or --source-dir.
15941652
```
15951653

1596-
_See code: [src/commands/project/retrieve/start.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.10/src/commands/project/retrieve/start.ts)_
1654+
_See code: [src/commands/project/retrieve/start.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.0/src/commands/project/retrieve/start.ts)_
15971655

15981656
<!-- commandsstop -->

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@salesforce/plugin-deploy-retrieve",
33
"description": "deploy and retrieve commands for sf",
4-
"version": "3.7.10",
4+
"version": "3.8.0",
55
"author": "Salesforce",
66
"bugs": "https://github.com/forcedotcom/cli/issues",
77
"dependencies": {

0 commit comments

Comments
 (0)