From 98ca078f09960704a74737f59604c98f3e9954ae Mon Sep 17 00:00:00 2001 From: SF-CLI-BOT Date: Wed, 1 Dec 2021 17:02:21 +0000 Subject: [PATCH] chore(release): 1.5.0 [ci skip] --- CHANGELOG.md | 2 ++ README.md | 72 ++++++++++++++++++++++++++++++++++++++++++---------- package.json | 2 +- 3 files changed, 62 insertions(+), 14 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 2ee25ffa..afc4b2cd 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.5.0](https://github.com/salesforcecli/cli/compare/v1.4.0...v1.5.0) (2021-12-01) + ## [1.4.0](https://github.com/salesforcecli/cli/compare/v1.3.1...v1.4.0) (2021-11-17) ### [1.3.1](https://github.com/salesforcecli/cli/compare/v1.3.0...v1.3.1) (2021-11-11) diff --git a/README.md b/README.md index 225ac5f4..ed0df616 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ $ npm install -g @salesforce/cli $ sf COMMAND running command... $ sf (--version|-v|version) -@salesforce/cli/1.4.0 linux-x64 node-v14.18.1 +@salesforce/cli/1.5.0 linux-x64 node-v14.18.2 $ sf --help [COMMAND] USAGE $ sf COMMAND @@ -80,6 +80,8 @@ USAGE * [`sf retrieve metadata`](#sf-retrieve-metadata) * [`sf run function`](#sf-run-function) * [`sf run function start`](#sf-run-function-start) +* [`sf run function start local`](#sf-run-function-start-local) +* [`sf update [CHANNEL]`](#sf-update-channel) * [`sf whoami functions`](#sf-whoami-functions) ## `sf config get` @@ -995,7 +997,7 @@ EXAMPLES $ sf login ``` -_See code: [@salesforce/plugin-login](https://github.com/salesforcecli/plugin-login/blob/v1.0.5/src/commands/login.ts)_ +_See code: [@salesforce/plugin-login](https://github.com/salesforcecli/plugin-login/blob/v1.0.6/src/commands/login.ts)_ ## `sf login functions` @@ -1102,16 +1104,17 @@ EXAMPLES Log in to a sandbox and set it as your default org: - $ sf login org --instance-url https://test.salesforce.com --set-default + $ sf login org --instance-url https://MyDomainName--SandboxName.sandbox.my.salesforce.com --set-default Use --browser to specify a specific browser, such as Google Chrome: - $ sf login org --instance-url https://test.salesforce.com --set-default --browser chrome + $ sf login org --instance-url https://MyDomainName--SandboxName.sandbox.my.salesforce.com --set-default \ + --browser chrome Use your own connected app by specifying its consumer key (also called client ID): - $ sf login org --instance-url https://test.salesforce.com --set-default --browser chrome --clientid \ - 04580y4051234051 + $ sf login org --instance-url https://MyDomainName--SandboxName.sandbox.my.salesforce.com --set-default \ + --browser chrome --clientid 04580y4051234051 FLAG DESCRIPTIONS -b, --browser= Browser in which to open the org. @@ -1126,7 +1129,7 @@ FLAG DESCRIPTIONS To specify a My Domain URL, use the format https://yourcompanyname.my.salesforce.com. - To specify a sandbox, set --instance-url to https://test.salesforce.com. + To specify a sandbox, set --instance-url to https://MyDomainName--SandboxName.sandbox.my.salesforce.com. CONFIGURATION VARIABLES apiVersion API version of your project. Default: API version of your Dev Hub org. @@ -1205,10 +1208,10 @@ EXAMPLES $ sf login org jwt --username jdoe@example.org --keyfile /Users/jdoe/JWT/server.key --clientid 04580y4051234051 \ --alias ci-dev-hub --set-default-dev-hub - Log in to a sandbox using URL https://test.salesforce.com: + Log in to a sandbox using URL https://MyDomainName--SandboxName.sandbox.my.salesforce.com: $ sf login org jwt --username jdoe@example.org --keyfile /Users/jdoe/JWT/server.key --clientid 04580y4051234051 \ - --alias ci-org --set-default --instance-url https://test.salesforce.com + --alias ci-org --set-default --instance-url https://MyDomainName--SandboxName.sandbox.my.salesforce.com FLAG DESCRIPTIONS -l, --instance-url= URL of the instance that the org lives on. @@ -1217,7 +1220,7 @@ FLAG DESCRIPTIONS To specify a My Domain URL, use the format https://yourcompanyname.my.salesforce.com. - To specify a sandbox, set --instance-url to https://test.salesforce.com. + To specify a sandbox, set --instance-url to https://MyDomainName--SandboxName.sandbox.my.salesforce.com. CONFIGURATION VARIABLES apiVersion API version of your project. Default: API version of your Dev Hub org. @@ -1261,7 +1264,7 @@ EXAMPLES $ sf logout --no-prompt ``` -_See code: [@salesforce/plugin-login](https://github.com/salesforcecli/plugin-login/blob/v1.0.5/src/commands/logout.ts)_ +_See code: [@salesforce/plugin-login](https://github.com/salesforcecli/plugin-login/blob/v1.0.6/src/commands/logout.ts)_ ## `sf logout functions` @@ -1593,7 +1596,7 @@ EXAMPLES ## `sf run function start` -Build and run a Salesforce Function locally. +Build and run a Salesforce Function in a container. ``` USAGE @@ -1610,7 +1613,7 @@ FLAGS --no-pull Skip pulling builder image before use. DESCRIPTION - Build and run a Salesforce Function locally. + Build and run a Salesforce Function in a container. Run this command from the directory of your Salesforce Functions project. @@ -1628,6 +1631,49 @@ EXAMPLES $ sf run function start --env KEY=VALUE --network host ``` +## `sf run function start local` + +Build and run a Salesforce Function locally. + +``` +USAGE + $ sf run function start local [-p ] [-b ] [-l javascript|typescript|java|auto] + +FLAGS + -b, --debug-port= [default: 9229] Port to use for debbugging the function. + -l, --language=(javascript|typescript|java|auto) [default: auto] The language that the function runs in. + -p, --port= [default: 8080] Port to bind the invoker to. + +DESCRIPTION + Build and run a Salesforce Function locally. + +EXAMPLES + Build a function and start the invoker + + $ sf run function start local + + Start the invoker with a specific language and port + + $ sf run function start local --port 5000 --language javascript +``` + +## `sf update [CHANNEL]` + +update the sf CLI + +``` +USAGE + $ sf update [CHANNEL] [--from-local] + +FLAGS + --from-local interactively choose an already installed version + +DESCRIPTION + update the sf CLI +``` + +_See code: [@oclif/plugin-update](https://github.com/oclif/plugin-update/blob/v2.0.0/src/commands/update.ts)_ + ## `sf whoami functions` Show information on your Salesforce Functions login. diff --git a/package.json b/package.json index 45358139..8a432188 100644 --- a/package.json +++ b/package.json @@ -179,4 +179,4 @@ "ts-node": "^10.2.1", "typescript": "^4.4.3" } -} \ No newline at end of file +}