diff --git a/CHANGELOG.md b/CHANGELOG.md index 06bf4a0b8..08999f704 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,13 @@ 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.5.0](https://github.com/salesforcecli/plugin-source/compare/v1.4.3...v1.5.0) (2021-11-16) + + +### Features + +* add mdapi:deploy:cancel command, refactor base classes to support MDAPI and SOURCE stash keys ([#301](https://github.com/salesforcecli/plugin-source/issues/301)) ([9dcc3e7](https://github.com/salesforcecli/plugin-source/commit/9dcc3e7bc1be13d1dcb0df13b3f7710407f9e977)) + ### [1.4.3](https://github.com/salesforcecli/plugin-source/compare/v1.4.2...v1.4.3) (2021-11-15) diff --git a/README.md b/README.md index 91f0b9607..dd6946fa0 100644 --- a/README.md +++ b/README.md @@ -80,7 +80,7 @@ $ npm install -g @salesforce/plugin-source $ sfdx COMMAND running command... $ sfdx (-v|--version|version) -@salesforce/plugin-source/1.4.2 linux-x64 node-v12.22.7 +@salesforce/plugin-source/1.4.3 linux-x64 node-v12.22.7 $ sfdx --help [COMMAND] USAGE $ sfdx COMMAND @@ -91,6 +91,7 @@ USAGE # Commands +* [`sfdx force:mdapi:deploy:cancel [-w ] [-i ] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcemdapideploycancel--w-minutes--i-id--u-string---apiversion-string---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) @@ -107,6 +108,54 @@ USAGE * [`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:deploy:cancel [-w ] [-i ] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +cancel a metadata deployment + +``` +cancel a metadata deployment + Use this command to cancel a specified asynchronous metadata deployment. You can also specify a wait time (in minutes) to check for updates to the canceled deploy status. + +USAGE + $ sfdx force:mdapi:deploy:cancel [-w ] [-i ] [-u ] [--apiversion ] [--json] [--loglevel + trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -i, --jobid=jobid job ID of the deployment you want to + cancel; defaults to your most recent + CLI deployment if not specified + + -u, --targetusername=targetusername username or alias for the target + org; overrides default target org + + -w, --wait=wait [default: 33 minutes] wait time for + command to finish in minutes + + --apiversion=apiversion override the api version used for + api requests made by this command + + --json format output as json + + --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for + this command invocation + +DESCRIPTION + Use this command to cancel a specified asynchronous metadata deployment. You can also specify a wait time (in minutes) + to check for updates to the canceled deploy status. + +EXAMPLES + Deploy a directory of files to the org + $ sfdx force:mdapi:deploy -d + Now cancel this deployment and wait two minutes + $ sfdx force:mdapi:deploy:cancel -w 2 + If you have multiple deployments in progress and want to cancel a specific one, specify the job ID + $ sfdx force:mdapi:deploy:cancel -i + Check the status of the cancel job + $ sfdx force:mdapi:deploy:report +``` + +_See code: [src/commands/force/mdapi/deploy/cancel.ts](https://github.com/salesforcecli/plugin-source/blob/v1.4.3/src/commands/force/mdapi/deploy/cancel.ts)_ + ## `sfdx force:mdapi:describemetadata [-f ] [-u ] [-a ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` display details about the metadata types enabled for your org @@ -149,7 +198,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.4.2/src/commands/force/mdapi/describemetadata.ts)_ +_See code: [src/commands/force/mdapi/describemetadata.ts](https://github.com/salesforcecli/plugin-source/blob/v1.4.3/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]` @@ -205,7 +254,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.4.2/src/commands/force/mdapi/listmetadata.ts)_ +_See code: [src/commands/force/mdapi/listmetadata.ts](https://github.com/salesforcecli/plugin-source/blob/v1.4.3/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]` @@ -240,7 +289,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.4.2/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.3/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]` @@ -281,7 +330,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.4.2/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.3/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]` @@ -319,7 +368,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.4.2/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.3/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]` @@ -358,7 +407,7 @@ DESCRIPTION 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.4.2/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.3/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]` @@ -408,7 +457,7 @@ DESCRIPTION $ 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.4.2/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.3/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]` @@ -430,7 +479,7 @@ USAGE OPTIONS -d, --outputdir=outputdir [default: - metadataPackage_1637007302184] + metadataPackage_1637100105638] output directory to store the Metadata API–formatted files in @@ -468,7 +517,7 @@ 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.4.2/src/commands/force/source/convert.ts)_ +_See code: [src/commands/force/source/convert.ts](https://github.com/salesforcecli/plugin-source/blob/v1.4.3/src/commands/force/source/convert.ts)_ ## `sfdx ` @@ -524,7 +573,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.4.2/src/commands/force/source/delete.ts)_ +_See code: [src/commands/force/source/delete.ts](https://github.com/salesforcecli/plugin-source/blob/v1.4.3/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]` @@ -653,7 +702,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.4.2/src/commands/force/source/deploy.ts)_ +_See code: [src/commands/force/source/deploy.ts](https://github.com/salesforcecli/plugin-source/blob/v1.4.3/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]` @@ -708,7 +757,7 @@ EXAMPLES $ sfdx force:source:deploy:report ``` -_See code: [src/commands/force/source/deploy/cancel.ts](https://github.com/salesforcecli/plugin-source/blob/v1.4.2/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.3/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]` @@ -758,7 +807,7 @@ EXAMPLES $ sfdx force:source:deploy:report ``` -_See code: [src/commands/force/source/deploy/report.ts](https://github.com/salesforcecli/plugin-source/blob/v1.4.2/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.3/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]` @@ -837,7 +886,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.4.2/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.3/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]` @@ -887,7 +936,7 @@ 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.4.2/src/commands/force/source/open.ts)_ +_See code: [src/commands/force/source/open.ts](https://github.com/salesforcecli/plugin-source/blob/v1.4.3/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]` @@ -975,5 +1024,5 @@ EXAMPLES $ 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.4.2/src/commands/force/source/retrieve.ts)_ +_See code: [src/commands/force/source/retrieve.ts](https://github.com/salesforcecli/plugin-source/blob/v1.4.3/src/commands/force/source/retrieve.ts)_ diff --git a/package.json b/package.json index e9379d5ab..4315ed167 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.3", + "version": "1.5.0", "author": "Salesforce", "bugs": "https://github.com/forcedotcom/cli/issues", "dependencies": {