diff --git a/CHANGELOG.md b/CHANGELOG.md index d6941253e..048948335 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,8 @@ All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines. +### [1.4.1](https://github.com/salesforcecli/plugin-source/compare/v1.4.0...v1.4.1) (2021-11-11) + ## [1.4.0](https://github.com/salesforcecli/plugin-source/compare/v1.3.1...v1.4.0) (2021-11-09) ### Features diff --git a/README.md b/README.md index 5ea6bc6d4..cc3a1bcf5 100644 --- a/README.md +++ b/README.md @@ -75,40 +75,37 @@ sfdx plugins # Usage - ```sh-session $ npm install -g @salesforce/plugin-source $ sfdx COMMAND running command... $ sfdx (-v|--version|version) -@salesforce/plugin-source/1.3.1 linux-x64 node-v12.22.7 +@salesforce/plugin-source/1.4.0 linux-x64 node-v12.22.7 $ sfdx --help [COMMAND] USAGE $ sfdx COMMAND ... ``` - # Commands - -- [`sfdx force:mdapi:describemetadata [-f ] [-u ] [-a ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcemdapidescribemetadata--f-filepath--u-string--a-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) -- [`sfdx force:mdapi:listmetadata -m [-f ] [--folder ] [-u ] [-a ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcemdapilistmetadata--m-string--f-filepath---folder-string--u-string--a-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) -- [`sfdx force:source:beta:pull [-f] [-w ] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcesourcebetapull--f--w-minutes--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) -- [`sfdx force:source:beta:push [-f] [-w ] [-g] [-u ] [--apiversion ] [--quiet] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcesourcebetapush--f--w-minutes--g--u-string---apiversion-string---quiet---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) -- [`sfdx force:source:beta:status [-l | -r] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcesourcebetastatus--l---r--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) -- [`sfdx force:source:beta:tracking:clear [-p] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcesourcebetatrackingclear--p--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) -- [`sfdx force:source:beta:tracking:reset [-r ] [-p] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcesourcebetatrackingreset--r-integer--p--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) -- [`sfdx force:source:convert [-r ] [-d ] [-n ] [-p | -x | -m ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcesourceconvert--r-directory--d-directory--n-string--p-array---x-string---m-array---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) -- [`sfdx `](#sfdx-) -- [`sfdx force:source:deploy [--soapdeploy] [-w ] [-q | -x | -m | -p | -c | -l NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg | -r | -o | -g] [--predestructivechanges ] [--postdestructivechanges ] [-u ] [--apiversion ] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcesourcedeploy---soapdeploy--w-minutes--q-id---x-filepath---m-array---p-array---c---l-notestrunrunspecifiedtestsrunlocaltestsrunalltestsinorg---r-array---o---g---predestructivechanges-filepath----postdestructivechanges-filepath---u-string---apiversion-string---verbose---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) -- [`sfdx force:source:deploy:cancel [-w ] [-i ] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcesourcedeploycancel--w-minutes--i-id--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) -- [`sfdx force:source:deploy:report [-w ] [-i ] [-u ] [--apiversion ] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcesourcedeployreport--w-minutes--i-id--u-string---apiversion-string---verbose---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) -- [`sfdx force:source:manifest:create [-m | -p ] [-n | -t pre|post|destroy|package] [-o ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcesourcemanifestcreate--m-array---p-array--n-string---t-prepostdestroypackage--o-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) -- [`sfdx force:source:open -f [-r] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcesourceopen--f-filepath--r--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) -- [`sfdx force:source:retrieve [-p | -x | -m ] [-w ] [-n ] [-u ] [-a ] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcesourceretrieve--p-array---x-filepath---m-array--w-minutes--n-array--u-string--a-string---verbose---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx force:mdapi:describemetadata [-f ] [-u ] [-a ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcemdapidescribemetadata--f-filepath--u-string--a-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx force:mdapi:listmetadata -m [-f ] [--folder ] [-u ] [-a ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcemdapilistmetadata--m-string--f-filepath---folder-string--u-string--a-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx force:source:beta:pull [-f] [-w ] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcesourcebetapull--f--w-minutes--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx force:source:beta:push [-f] [-w ] [-g] [-u ] [--apiversion ] [--quiet] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcesourcebetapush--f--w-minutes--g--u-string---apiversion-string---quiet---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx force:source:beta:status [-l | -r] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcesourcebetastatus--l---r--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx force:source:beta:tracking:clear [-p] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcesourcebetatrackingclear--p--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx force:source:beta:tracking:reset [-r ] [-p] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcesourcebetatrackingreset--r-integer--p--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx force:source:convert [-r ] [-d ] [-n ] [-p | -x | -m ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcesourceconvert--r-directory--d-directory--n-string--p-array---x-string---m-array---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx `](#sfdx-) +* [`sfdx force:source:deploy [--soapdeploy] [-w ] [-q | -x | -m | -p | -c | -l NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg | -r | -o | -g] [--predestructivechanges ] [--postdestructivechanges ] [-u ] [--apiversion ] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcesourcedeploy---soapdeploy--w-minutes--q-id---x-filepath---m-array---p-array---c---l-notestrunrunspecifiedtestsrunlocaltestsrunalltestsinorg---r-array---o---g---predestructivechanges-filepath----postdestructivechanges-filepath---u-string---apiversion-string---verbose---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx force:source:deploy:cancel [-w ] [-i ] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcesourcedeploycancel--w-minutes--i-id--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx force:source:deploy:report [-w ] [-i ] [-u ] [--apiversion ] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcesourcedeployreport--w-minutes--i-id--u-string---apiversion-string---verbose---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx force:source:manifest:create [-m | -p ] [-n | -t pre|post|destroy|package] [-o ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcesourcemanifestcreate--m-array---p-array--n-string---t-prepostdestroypackage--o-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx force:source:open -f [-r] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcesourceopen--f-filepath--r--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx force:source:retrieve [-p | -x | -m ] [-w ] [-n ] [-u ] [-a ] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcesourceretrieve--p-array---x-filepath---m-array--w-minutes--n-array--u-string--a-string---verbose---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) ## `sfdx force:mdapi:describemetadata [-f ] [-u ] [-a ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` @@ -118,7 +115,7 @@ display the metadata types enabled for your org display the metadata types enabled for your org USAGE - $ sfdx force:mdapi:describemetadata [-f ] [-u ] [-a ] [--json] [--loglevel + $ sfdx force:mdapi:describemetadata [-f ] [-u ] [-a ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] OPTIONS @@ -142,7 +139,7 @@ EXAMPLES $ sfdx force:mdapi:describemetadata -u me@example.com -f /path/to/outputfilename.txt ``` -_See code: [src/commands/force/mdapi/describemetadata.ts](https://github.com/salesforcecli/plugin-source/blob/v1.3.1/src/commands/force/mdapi/describemetadata.ts)_ +_See code: [src/commands/force/mdapi/describemetadata.ts](https://github.com/salesforcecli/plugin-source/blob/v1.4.0/src/commands/force/mdapi/describemetadata.ts)_ ## `sfdx force:mdapi:listmetadata -m [-f ] [--folder ] [-u ] [-a ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` @@ -152,7 +149,7 @@ display properties of metadata components of a specified type display properties of metadata components of a specified type USAGE - $ sfdx force:mdapi:listmetadata -m [-f ] [--folder ] [-u ] [-a ] [--json] + $ sfdx force:mdapi:listmetadata -m [-f ] [--folder ] [-u ] [-a ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] OPTIONS @@ -191,7 +188,7 @@ EXAMPLES $ sfdx force:mdapi:listmetadata -m CustomObject -u me@example.com -f /path/to/outputfilename.txt ``` -_See code: [src/commands/force/mdapi/listmetadata.ts](https://github.com/salesforcecli/plugin-source/blob/v1.3.1/src/commands/force/mdapi/listmetadata.ts)_ +_See code: [src/commands/force/mdapi/listmetadata.ts](https://github.com/salesforcecli/plugin-source/blob/v1.4.0/src/commands/force/mdapi/listmetadata.ts)_ ## `sfdx force:source:beta:pull [-f] [-w ] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` @@ -201,7 +198,7 @@ pull source from the scratch org to the project pull source from the scratch org to the project USAGE - $ sfdx force:source:beta:pull [-f] [-w ] [-u ] [--apiversion ] [--json] [--loglevel + $ sfdx force:source:beta:pull [-f] [-w ] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] OPTIONS @@ -212,8 +209,8 @@ OPTIONS username or alias for the target org; overrides default target org -w, --wait=wait - [default: 33 minutes] The number of minutes to wait for the command to complete and display results to the terminal - window. If the command continues to run after the wait period, the CLI returns control of the terminal window to + [default: 33 minutes] The number of minutes to wait for the command to complete and display results to the terminal + window. If the command continues to run after the wait period, the CLI returns control of the terminal window to you. The default is 33 minutes. --apiversion=apiversion @@ -226,7 +223,7 @@ OPTIONS [default: warn] logging level for this command invocation ``` -_See code: [src/commands/force/source/beta/pull.ts](https://github.com/salesforcecli/plugin-source/blob/v1.3.1/src/commands/force/source/beta/pull.ts)_ +_See code: [src/commands/force/source/beta/pull.ts](https://github.com/salesforcecli/plugin-source/blob/v1.4.0/src/commands/force/source/beta/pull.ts)_ ## `sfdx force:source:beta:push [-f] [-w ] [-g] [-u ] [--apiversion ] [--quiet] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` @@ -236,7 +233,7 @@ push source to a scratch org from the project push source to a scratch org from the project USAGE - $ sfdx force:source:beta:push [-f] [-w ] [-g] [-u ] [--apiversion ] [--quiet] [--json] + $ sfdx force:source:beta:push [-f] [-w ] [-g] [-u ] [--apiversion ] [--quiet] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] OPTIONS @@ -250,8 +247,8 @@ OPTIONS username or alias for the target org; overrides default target org -w, --wait=wait - [default: 33 minutes] Number of minutes to wait for the command to complete and display results to the terminal - window. If the command continues to run after the wait period, the CLI returns control of the terminal window to + [default: 33 minutes] Number of minutes to wait for the command to complete and display results to the terminal + window. If the command continues to run after the wait period, the CLI returns control of the terminal window to you. The default is 33 minutes. --apiversion=apiversion @@ -267,7 +264,7 @@ OPTIONS minimize json and sdtout output on success ``` -_See code: [src/commands/force/source/beta/push.ts](https://github.com/salesforcecli/plugin-source/blob/v1.3.1/src/commands/force/source/beta/push.ts)_ +_See code: [src/commands/force/source/beta/push.ts](https://github.com/salesforcecli/plugin-source/blob/v1.4.0/src/commands/force/source/beta/push.ts)_ ## `sfdx force:source:beta:status [-l | -r] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` @@ -277,7 +274,7 @@ list local changes and/or changes in a scratch org list local changes and/or changes in a scratch org USAGE - $ sfdx force:source:beta:status [-l | -r] [-u ] [--apiversion ] [--json] [--loglevel + $ sfdx force:source:beta:status [-l | -r] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] OPTIONS @@ -305,7 +302,7 @@ EXAMPLES sfdx force:source:status -a -u me@example.com --json ``` -_See code: [src/commands/force/source/beta/status.ts](https://github.com/salesforcecli/plugin-source/blob/v1.3.1/src/commands/force/source/beta/status.ts)_ +_See code: [src/commands/force/source/beta/status.ts](https://github.com/salesforcecli/plugin-source/blob/v1.4.0/src/commands/force/source/beta/status.ts)_ ## `sfdx force:source:beta:tracking:clear [-p] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` @@ -319,7 +316,7 @@ WARNING: This command deletes or overwrites all existing source tracking files. Clears all local source tracking information. When you next run force:source:beta:status, the CLI displays all local and remote files as changed, and any files with the same name are listed as conflicts. USAGE - $ sfdx force:source:beta:tracking:clear [-p] [-u ] [--apiversion ] [--json] [--loglevel + $ sfdx force:source:beta:tracking:clear [-p] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] OPTIONS @@ -340,11 +337,11 @@ OPTIONS DESCRIPTION WARNING: This command deletes or overwrites all existing source tracking files. Use with extreme caution. - Clears all local source tracking information. When you next run force:source:beta:status, the CLI displays all local + Clears all local source tracking information. When you next run force:source:beta:status, the CLI displays all local and remote files as changed, and any files with the same name are listed as conflicts. ``` -_See code: [src/commands/force/source/beta/tracking/clear.ts](https://github.com/salesforcecli/plugin-source/blob/v1.3.1/src/commands/force/source/beta/tracking/clear.ts)_ +_See code: [src/commands/force/source/beta/tracking/clear.ts](https://github.com/salesforcecli/plugin-source/blob/v1.4.0/src/commands/force/source/beta/tracking/clear.ts)_ ## `sfdx force:source:beta:tracking:reset [-r ] [-p] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` @@ -353,7 +350,7 @@ reset local and remote source tracking ``` reset local and remote source tracking - WARNING: This command deletes or overwrites all existing source tracking files. Use with extreme caution. + WARNING: This command deletes or overwrites all existing source tracking files. Use with extreme caution. Resets local and remote source tracking so that the CLI no longer registers differences between your local files and those in the org. When you next run force:source:beta:status, the CLI returns no results, even though conflicts might actually exist. The CLI then resumes tracking new source changes as usual. @@ -361,7 +358,7 @@ Use the --revision parameter to reset source tracking to a specific revision num $ sfdx force:data:soql:query -q "SELECT MemberName, MemberType, RevisionCounter FROM SourceMember" -t USAGE - $ sfdx force:source:beta:tracking:reset [-r ] [-p] [-u ] [--apiversion ] [--json] [--loglevel + $ sfdx force:source:beta:tracking:reset [-r ] [-p] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] OPTIONS @@ -383,26 +380,26 @@ OPTIONS this command invocation DESCRIPTION - WARNING: This command deletes or overwrites all existing source tracking files. Use with extreme caution. + WARNING: This command deletes or overwrites all existing source tracking files. Use with extreme caution. - Resets local and remote source tracking so that the CLI no longer registers differences between your local files and - those in the org. When you next run force:source:beta:status, the CLI returns no results, even though conflicts might + Resets local and remote source tracking so that the CLI no longer registers differences between your local files and + those in the org. When you next run force:source:beta:status, the CLI returns no results, even though conflicts might actually exist. The CLI then resumes tracking new source changes as usual. - Use the --revision parameter to reset source tracking to a specific revision number of an org source member. To get + Use the --revision parameter to reset source tracking to a specific revision number of an org source member. To get the revision number, query the SourceMember Tooling API object with the force:data:soql:query command. For example: $ sfdx force:data:soql:query -q "SELECT MemberName, MemberType, RevisionCounter FROM SourceMember" -t ``` -_See code: [src/commands/force/source/beta/tracking/reset.ts](https://github.com/salesforcecli/plugin-source/blob/v1.3.1/src/commands/force/source/beta/tracking/reset.ts)_ +_See code: [src/commands/force/source/beta/tracking/reset.ts](https://github.com/salesforcecli/plugin-source/blob/v1.4.0/src/commands/force/source/beta/tracking/reset.ts)_ ## `sfdx force:source:convert [-r ] [-d ] [-n ] [-p | -x | -m ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` -convert source into Metadata API format +convert source into Metadata API format ``` -convert source into Metadata API format - Converts source-formatted files into metadata that you can deploy using Metadata API. +convert source into Metadata API format + Converts source-formatted files into metadata that you can deploy using Metadata API. To convert source-formatted files into the metadata format, so that you can deploy them using Metadata API, run "sfdx force:source:convert". Then deploy the metadata using "sfdx force:mdapi:deploy". @@ -411,12 +408,12 @@ To convert Metadata API–formatted files into the source format, run "sfdx forc To specify a package name that includes spaces, enclose the name in single quotes. USAGE - $ sfdx force:source:convert [-r ] [-d ] [-n ] [-p | -x | -m ] + $ sfdx force:source:convert [-r ] [-d ] [-n ] [-p | -x | -m ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] OPTIONS -d, --outputdir=outputdir [default: - metadataPackage_1636499010974] + metadataPackage_1636649606778] output directory to store the Metadata API–formatted files in @@ -441,7 +438,7 @@ OPTIONS this command invocation DESCRIPTION - Converts source-formatted files into metadata that you can deploy using Metadata API. + Converts source-formatted files into metadata that you can deploy using Metadata API. To convert source-formatted files into the metadata format, so that you can deploy them using Metadata API, run "sfdx force:source:convert". Then deploy the metadata using "sfdx force:mdapi:deploy". @@ -454,14 +451,14 @@ EXAMPLES $ sfdx force:source:convert -r path/to/source -d path/to/outputdir -n 'My Package' ``` -_See code: [src/commands/force/source/convert.ts](https://github.com/salesforcecli/plugin-source/blob/v1.3.1/src/commands/force/source/convert.ts)_ +_See code: [src/commands/force/source/convert.ts](https://github.com/salesforcecli/plugin-source/blob/v1.4.0/src/commands/force/source/convert.ts)_ ## `sfdx ` -delete source from your project and from a non-source-tracked org +delete source from your project and from a non-source-tracked org ``` -delete source from your project and from a non-source-tracked org +delete source from your project and from a non-source-tracked org Use this command to delete components from orgs that don’t have source tracking. To remove deleted items from scratch orgs, which have change tracking, use "sfdx force:source:push". @@ -510,7 +507,7 @@ EXAMPLES $ sfdx force:source:delete -p path/to/source ``` -_See code: [src/commands/force/source/delete.ts](https://github.com/salesforcecli/plugin-source/blob/v1.3.1/src/commands/force/source/delete.ts)_ +_See code: [src/commands/force/source/delete.ts](https://github.com/salesforcecli/plugin-source/blob/v1.4.0/src/commands/force/source/delete.ts)_ ## `sfdx force:source:deploy [--soapdeploy] [-w ] [-q | -x | -m | -p | -c | -l NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg | -r | -o | -g] [--predestructivechanges ] [--postdestructivechanges ] [-u ] [--apiversion ] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` @@ -531,9 +528,9 @@ If the comma-separated list you’re supplying contains spaces, enclose the enti If you use the --manifest, --predestructivechanges, or --postdestructivechanges parameters, run the force:source:manifest:create command to easily generate the different types of manifest files. USAGE - $ sfdx force:source:deploy [--soapdeploy] [-w ] [-q | -x | -m | -p | -c | -l - NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg | -r | -o | -g] [--predestructivechanges - ] [--postdestructivechanges ] [-u ] [--apiversion ] [--verbose] [--json] [--loglevel + $ sfdx force:source:deploy [--soapdeploy] [-w ] [-q | -x | -m | -p | -c | -l + NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg | -r | -o | -g] [--predestructivechanges + ] [--postdestructivechanges ] [-u ] [--apiversion ] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] OPTIONS @@ -598,22 +595,22 @@ DESCRIPTION To take advantage of change tracking with scratch orgs, use "sfdx force:source:push". To deploy metadata that’s in metadata format, use "sfdx force:mdapi:deploy". - The source you deploy overwrites the corresponding metadata in your org. This command does not attempt to merge your + The source you deploy overwrites the corresponding metadata in your org. This command does not attempt to merge your source with the versions in your org. - To run the command asynchronously, set --wait to 0, which immediately returns the job ID. This way, you can continue + To run the command asynchronously, set --wait to 0, which immediately returns the job ID. This way, you can continue to use the CLI. To check the status of the job, use force:source:deploy:report. - If the comma-separated list you’re supplying contains spaces, enclose the entire comma-separated list in one set of + If the comma-separated list you’re supplying contains spaces, enclose the entire comma-separated list in one set of double quotes. On Windows, if the list contains commas, also enclose the entire list in one set of double quotes. - If you use the --manifest, --predestructivechanges, or --postdestructivechanges parameters, run the + If you use the --manifest, --predestructivechanges, or --postdestructivechanges parameters, run the force:source:manifest:create command to easily generate the different types of manifest files. EXAMPLES To deploy the source files in a directory: $ sfdx force:source:deploy -p path/to/source - To deploy a specific Apex class and the objects whose source is in a directory: + To deploy a specific Apex class and the objects whose source is in a directory: $ sfdx force:source:deploy -p "path/to/apex/classes/MyClass.cls,path/to/source/objects" To deploy source files in a comma-separated list that contains spaces: $ sfdx force:source:deploy -p "path/to/objects/MyCustomObject/fields/MyField.field-meta.xml, path/to/apex/classes" @@ -639,7 +636,7 @@ EXAMPLES $ sfdx force:source:deploy --manifest package.xml --postdestructivechanges destructiveChangesPost.xml ``` -_See code: [src/commands/force/source/deploy.ts](https://github.com/salesforcecli/plugin-source/blob/v1.3.1/src/commands/force/source/deploy.ts)_ +_See code: [src/commands/force/source/deploy.ts](https://github.com/salesforcecli/plugin-source/blob/v1.4.0/src/commands/force/source/deploy.ts)_ ## `sfdx force:source:deploy:cancel [-w ] [-i ] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` @@ -653,7 +650,7 @@ To run the command asynchronously, set --wait to 0, which immediately returns th To check the status of the job, use force:source:deploy:report. USAGE - $ sfdx force:source:deploy:cancel [-w ] [-i ] [-u ] [--apiversion ] [--json] [--loglevel + $ sfdx force:source:deploy:cancel [-w ] [-i ] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] OPTIONS @@ -676,10 +673,10 @@ OPTIONS this command invocation DESCRIPTION - Use this command to cancel a specified asynchronous source deployment. You can also specify a wait time (in minutes) + Use this command to cancel a specified asynchronous source deployment. You can also specify a wait time (in minutes) to check for updates to the canceled deploy status. - To run the command asynchronously, set --wait to 0, which immediately returns the job ID. This way, you can continue + To run the command asynchronously, set --wait to 0, which immediately returns the job ID. This way, you can continue to use the CLI. To check the status of the job, use force:source:deploy:report. @@ -694,18 +691,18 @@ EXAMPLES $ sfdx force:source:deploy:report ``` -_See code: [src/commands/force/source/deploy/cancel.ts](https://github.com/salesforcecli/plugin-source/blob/v1.3.1/src/commands/force/source/deploy/cancel.ts)_ +_See code: [src/commands/force/source/deploy/cancel.ts](https://github.com/salesforcecli/plugin-source/blob/v1.4.0/src/commands/force/source/deploy/cancel.ts)_ ## `sfdx force:source:deploy:report [-w ] [-i ] [-u ] [--apiversion ] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` -check the status of a metadata deployment +check the status of a metadata deployment ``` -check the status of a metadata deployment +check the status of a metadata deployment Specify the job ID for the deploy you want to check. You can also specify a wait time (minutes) to check for updates to the deploy status. USAGE - $ sfdx force:source:deploy:report [-w ] [-i ] [-u ] [--apiversion ] [--verbose] [--json] + $ sfdx force:source:deploy:report [-w ] [-i ] [-u ] [--apiversion ] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] OPTIONS @@ -730,7 +727,7 @@ OPTIONS --verbose verbose output of deploy result DESCRIPTION - Specify the job ID for the deploy you want to check. You can also specify a wait time (minutes) to check for updates + Specify the job ID for the deploy you want to check. You can also specify a wait time (minutes) to check for updates to the deploy status. EXAMPLES @@ -744,14 +741,14 @@ EXAMPLES $ sfdx force:source:deploy:report ``` -_See code: [src/commands/force/source/deploy/report.ts](https://github.com/salesforcecli/plugin-source/blob/v1.3.1/src/commands/force/source/deploy/report.ts)_ +_See code: [src/commands/force/source/deploy/report.ts](https://github.com/salesforcecli/plugin-source/blob/v1.4.0/src/commands/force/source/deploy/report.ts)_ ## `sfdx force:source:manifest:create [-m | -p ] [-n | -t pre|post|destroy|package] [-o ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` -create a project manifest that lists the metadata components you want to deploy or retrieve +create a project manifest that lists the metadata components you want to deploy or retrieve ``` -create a project manifest that lists the metadata components you want to deploy or retrieve +create a project manifest that lists the metadata components you want to deploy or retrieve Create a manifest from a list of metadata components (--metadata) or from one or more local directories that contain source files (--sourcepath). You can specify either of these parameters, not both. Use --manifesttype to specify the type of manifest you want to create. The resulting manifest files have specific names, such as the standard package.xml or destructiveChanges.xml to delete metadata. Valid values for this parameter, and their respective file names, are: @@ -761,14 +758,14 @@ Use --manifesttype to specify the type of manifest you want to create. The resul post : destructiveChangesPost.xml destroy : destructiveChanges.xml -See https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy_deleting_files.htm for information about these destructive manifest files. +See https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy_deleting_files.htm for information about these destructive manifest files. Use --manifestname to specify a custom name for the generated manifest if the pre-defined ones don’t suit your needs. You can specify either --manifesttype or --manifestname, but not both. USAGE - $ sfdx force:source:manifest:create [-m | -p ] [-n | -t pre|post|destroy|package] [-o - ] [--apiversion ] [--json] [--loglevel + $ sfdx force:source:manifest:create [-m | -p ] [-n | -t pre|post|destroy|package] [-o + ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] OPTIONS @@ -799,11 +796,11 @@ OPTIONS this command invocation DESCRIPTION - Create a manifest from a list of metadata components (--metadata) or from one or more local directories that contain + Create a manifest from a list of metadata components (--metadata) or from one or more local directories that contain source files (--sourcepath). You can specify either of these parameters, not both. - Use --manifesttype to specify the type of manifest you want to create. The resulting manifest files have specific - names, such as the standard package.xml or destructiveChanges.xml to delete metadata. Valid values for this parameter, + Use --manifesttype to specify the type of manifest you want to create. The resulting manifest files have specific + names, such as the standard package.xml or destructiveChanges.xml to delete metadata. Valid values for this parameter, and their respective file names, are: package : package.xml (default) @@ -811,10 +808,10 @@ DESCRIPTION post : destructiveChangesPost.xml destroy : destructiveChanges.xml - See https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy_deleting_files.htm for - information about these destructive manifest files. + See https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy_deleting_files.htm for + information about these destructive manifest files. - Use --manifestname to specify a custom name for the generated manifest if the pre-defined ones don’t suit your needs. + Use --manifestname to specify a custom name for the generated manifest if the pre-defined ones don’t suit your needs. You can specify either --manifesttype or --manifestname, but not both. EXAMPLES @@ -823,7 +820,7 @@ EXAMPLES $ sfdx force:source:manifest:create --sourcepath force-app --manifestname myNewManifest ``` -_See code: [src/commands/force/source/manifest/create.ts](https://github.com/salesforcecli/plugin-source/blob/v1.3.1/src/commands/force/source/manifest/create.ts)_ +_See code: [src/commands/force/source/manifest/create.ts](https://github.com/salesforcecli/plugin-source/blob/v1.4.0/src/commands/force/source/manifest/create.ts)_ ## `sfdx force:source:open -f [-r] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` @@ -838,7 +835,7 @@ If no browser-based editor is available for the selected file, this command open To generate a URL for the browser-based editor but not open the editor, use --urlonly. USAGE - $ sfdx force:source:open -f [-r] [-u ] [--apiversion ] [--json] [--loglevel + $ sfdx force:source:open -f [-r] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] OPTIONS @@ -859,8 +856,8 @@ OPTIONS this command invocation DESCRIPTION - Opens the specified Lightning Page in Lightning App Builder. Lightning Page files have the suffix .flexipage-meta.xml, - and are stored in the flexipages directory. If you specify a different type of file, this command opens your org’s + Opens the specified Lightning Page in Lightning App Builder. Lightning Page files have the suffix .flexipage-meta.xml, + and are stored in the flexipages directory. If you specify a different type of file, this command opens your org’s home page. The file opens in your default browser. @@ -873,14 +870,14 @@ EXAMPLES $ sfdx force:source:open -f path/to/source -u my-user@my-org.com ``` -_See code: [src/commands/force/source/open.ts](https://github.com/salesforcecli/plugin-source/blob/v1.3.1/src/commands/force/source/open.ts)_ +_See code: [src/commands/force/source/open.ts](https://github.com/salesforcecli/plugin-source/blob/v1.4.0/src/commands/force/source/open.ts)_ ## `sfdx force:source:retrieve [-p | -x | -m ] [-w ] [-n ] [-u ] [-a ] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` -retrieve source from an org +retrieve source from an org ``` -retrieve source from an org +retrieve source from an org Use this command to retrieve source (metadata that’s in source format) from an org. To take advantage of change tracking with scratch orgs, use "sfdx force:source:pull". To retrieve metadata that’s in metadata format, use "sfdx force:mdapi:retrieve". @@ -890,7 +887,7 @@ The source you retrieve overwrites the corresponding source files in your local If the comma-separated list you’re supplying contains spaces, enclose the entire comma-separated list in one set of double quotes. On Windows, if the list contains commas, also enclose it in one set of double quotes. USAGE - $ sfdx force:source:retrieve [-p | -x | -m ] [-w ] [-n ] [-u ] [-a + $ sfdx force:source:retrieve [-p | -x | -m ] [-w ] [-n ] [-u ] [-a ] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] OPTIONS @@ -927,10 +924,10 @@ DESCRIPTION To take advantage of change tracking with scratch orgs, use "sfdx force:source:pull". To retrieve metadata that’s in metadata format, use "sfdx force:mdapi:retrieve". - The source you retrieve overwrites the corresponding source files in your local project. This command does not attempt + The source you retrieve overwrites the corresponding source files in your local project. This command does not attempt to merge the source from your org with your local source files. - If the comma-separated list you’re supplying contains spaces, enclose the entire comma-separated list in one set of + If the comma-separated list you’re supplying contains spaces, enclose the entire comma-separated list in one set of double quotes. On Windows, if the list contains commas, also enclose it in one set of double quotes. EXAMPLES @@ -939,7 +936,7 @@ EXAMPLES To retrieve a specific Apex class and the objects whose source is in a directory: $ sfdx force:source:retrieve -p "path/to/apex/classes/MyClass.cls,path/to/source/objects" To retrieve source files in a comma-separated list that contains spaces: - $ sfdx force:source:retrieve -p "path/to/objects/MyCustomObject/fields/MyField.field-meta.xml, + $ sfdx force:source:retrieve -p "path/to/objects/MyCustomObject/fields/MyField.field-meta.xml, path/to/apex/classes To retrieve all Apex classes: $ sfdx force:source:retrieve -m ApexClass @@ -954,13 +951,12 @@ EXAMPLES To retrieve metadata from a package or multiple packages: $ sfdx force:source:retrieve -n MyPackageName $ sfdx force:source:retrieve -n "Package1, PackageName With Spaces, Package3" - To retrieve all metadata from a package and specific components that aren’t in the package, specify both -n | + To retrieve all metadata from a package and specific components that aren’t in the package, specify both -n | --packagenames and one other scoping parameter: $ sfdx force:source:retrieve -n MyPackageName -p path/to/apex/classes $ sfdx force:source:retrieve -n MyPackageName -m ApexClass:MyApexClass $ sfdx force:source:retrieve -n MyPackageName -x path/to/package.xml ``` -_See code: [src/commands/force/source/retrieve.ts](https://github.com/salesforcecli/plugin-source/blob/v1.3.1/src/commands/force/source/retrieve.ts)_ - +_See code: [src/commands/force/source/retrieve.ts](https://github.com/salesforcecli/plugin-source/blob/v1.4.0/src/commands/force/source/retrieve.ts)_ diff --git a/package.json b/package.json index b8d368d87..8013aa4a3 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "@salesforce/plugin-source", "description": "Commands to interact with source formatted metadata", - "version": "1.4.0", + "version": "1.4.1", "author": "Salesforce", "bugs": "https://github.com/forcedotcom/cli/issues", "dependencies": {