From fdddb7f68083b032ea67d75a06224c4b4e9814df Mon Sep 17 00:00:00 2001 From: SF-CLI-BOT Date: Thu, 4 Nov 2021 21:27:19 +0000 Subject: [PATCH] chore(release): 1.1.7 [ci skip] --- CHANGELOG.md | 2 ++ README.md | 46 +++++++++++++++++++++++++++++++--------------- package.json | 2 +- 3 files changed, 34 insertions(+), 16 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 118fcddb..cabfa6e5 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.1.7](https://github.com/salesforcecli/plugin-functions/compare/v1.1.6...v1.1.7) (2021-11-04) + ### [1.1.6](https://github.com/salesforcecli/plugin-functions/compare/v1.1.5...v1.1.6) (2021-10-28) ### Bug Fixes diff --git a/README.md b/README.md index 19a03785..7c9ad6c5 100644 --- a/README.md +++ b/README.md @@ -76,6 +76,10 @@ FLAGS DESCRIPTION Create a compute environment for use with Salesforce Functions. + Compute environments must be connected to a Salesforce org. By default the command uses your local environment's + connected org. Use the '--connected-org' flag to specify a specific org. Run 'sf env list' to see a list of + environments. + EXAMPLES Create a compute environment to run Salesforce Functions: @@ -105,6 +109,12 @@ FLAGS DESCRIPTION Delete an environment. + You must include the name of the environment to delete using '--target-compute'. Run 'sf env list' to see a list of + environments. + + Running this command will prompt a confirmation. If you want to skip this confirmation, use the '--confirm' flag and + the environment alias to skip confirmation. + EXAMPLES Delete a compute environment: @@ -126,9 +136,6 @@ USAGE FLAGS -e, --target-compute= Compute environment name to retrieve logs. -DESCRIPTION - Stream log output for an environment. - EXAMPLES Stream log output: @@ -150,6 +157,9 @@ FLAGS DESCRIPTION Add log drain to a specified environment. + Both '--target-compute' and '--url' are required flags. '--url' should be a HTTP or HTTPS URL that can receive the log + drain messages. + EXAMPLES Add a log drain: @@ -168,9 +178,6 @@ FLAGS -e, --target-compute= Environment name. -j, --json Output list in JSON format. -DESCRIPTION - List log drains connected to a specified environment. - EXAMPLES List log drains: @@ -196,6 +203,8 @@ FLAGS DESCRIPTION Remove log drain from a specified environment. + Both '--target-compute' and '--drain-url' are required flags. + EXAMPLES Remove a logdrain: @@ -216,6 +225,8 @@ FLAGS DESCRIPTION Display a single config variable for an environment. + You must provide the '--target-compute' flag and the key to retrieve. + EXAMPLES Get a config variable: @@ -237,6 +248,8 @@ FLAGS DESCRIPTION List your environment's config vars in a table. + Use the '--json' flag to return config vars in JSON format. + EXAMPLES List config vars: @@ -258,9 +271,6 @@ USAGE FLAGS -e, --target-compute= Environment name. -DESCRIPTION - Set a single config value for an environment. - EXAMPLES Set a config value: @@ -281,6 +291,8 @@ FLAGS DESCRIPTION Unset a single config value for an environment. + Run 'sf env var list' to see a list of config values that can be unset. + EXAMPLES Unset a value: @@ -302,6 +314,8 @@ FLAGS DESCRIPTION Create a Salesforce Function with basic scaffolding specific to a given language. + Both '--language' and '--name' are required flags. Function names must start with a capital letter. + EXAMPLES Create a JavaScript function: @@ -319,6 +333,8 @@ USAGE DESCRIPTION Log in to Salesforce Functions. + This step is required to develop or deploy Salesforce Functions. + EXAMPLES Log in to Salesforce Functions: @@ -346,6 +362,8 @@ FLAGS DESCRIPTION Login using JWT instead of default web-based flow. This will authenticate you with both sf and Salesforce Functions. + Use this command when executing from a script. + EXAMPLES Log in using JWT: @@ -365,9 +383,6 @@ Log out of your Salesforce Functions account. USAGE $ sf logout functions -DESCRIPTION - Log out of your Salesforce Functions account. - EXAMPLES Log out: @@ -389,9 +404,6 @@ FLAGS -p, --payload= Set the payload of the cloudevent as a JSON object or a path to a file via @file.json. -s, --structured Set the cloudevent to be emitted as a structured JSON cloudevent. -DESCRIPTION - Send a cloudevent to a function. - EXAMPLES Run a function: @@ -423,6 +435,8 @@ FLAGS DESCRIPTION Build and run a Salesforce Function locally. + Run this command from the directory of your Salesforce Functions project. + EXAMPLES Build and run a function: @@ -451,6 +465,8 @@ FLAGS DESCRIPTION Show information on your Salesforce Functions login. + Returns your email and ID. Use '--show-token' to show your Salesforce Functions token. + EXAMPLES Get account information: diff --git a/package.json b/package.json index e4ce3acc..4660b6b6 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "@salesforce/plugin-functions", "description": "Functions plugin for the SF CLI", - "version": "1.1.6", + "version": "1.1.7", "author": "heroku-front-end@salesforce.com", "bin": { "functions": "./bin/run"