Skip to content

Commit

Permalink
chore(release): 0.2.6 [ci skip]
Browse files Browse the repository at this point in the history
  • Loading branch information
SF-CLI-BOT committed Jun 22, 2021
1 parent 4f3b107 commit 0094c66
Show file tree
Hide file tree
Showing 3 changed files with 63 additions and 44 deletions.
8 changes: 4 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,21 @@

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.

### [0.2.6](https://github.com/salesforcecli/plugin-functions/compare/v0.2.5...v0.2.6) (2021-06-22)

### [0.2.5](https://github.com/salesforcecli/plugin-functions/compare/v0.2.4...v0.2.5) (2021-06-21)

### [0.2.4](https://github.com/salesforcecli/plugin-functions/compare/v0.2.3...v0.2.4) (2021-06-16)


### Bug Fixes

* update run:function flags to match PRD ([#88](https://github.com/salesforcecli/plugin-functions/issues/88)) ([5fc61b5](https://github.com/salesforcecli/plugin-functions/commit/5fc61b5e5786c316a8957849b7aa829bd886570b))
- update run:function flags to match PRD ([#88](https://github.com/salesforcecli/plugin-functions/issues/88)) ([5fc61b5](https://github.com/salesforcecli/plugin-functions/commit/5fc61b5e5786c316a8957849b7aa829bd886570b))

### [0.2.3](https://github.com/salesforcecli/plugin-functions/compare/v0.2.2...v0.2.3) (2021-06-10)


### Bug Fixes

* force upsert results to always be an array ([#86](https://github.com/salesforcecli/plugin-functions/issues/86)) ([5e2ba4e](https://github.com/salesforcecli/plugin-functions/commit/5e2ba4e8329d3f476162346e814bc84fb55a306f))
- force upsert results to always be an array ([#86](https://github.com/salesforcecli/plugin-functions/issues/86)) ([5e2ba4e](https://github.com/salesforcecli/plugin-functions/commit/5e2ba4e8329d3f476162346e814bc84fb55a306f))

### [0.2.2](https://github.com/salesforcecli/plugin-functions/compare/v0.2.1...v0.2.2) (2021-06-09)

Expand Down
97 changes: 58 additions & 39 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,10 @@ Functions plugin for the SF CLI
[![NPM](https://img.shields.io/npm/v/@salesforce/plugin-functions.svg?label=@salesforce/functions)](https://www.npmjs.com/package/@salesforce/functions) [![CircleCI](https://circleci.com/gh/salesforcecli/plugin-functions/tree/main.svg?style=shield)](https://circleci.com/gh/salesforcecli/plugin-functions/tree/main) [![Downloads/week](https://img.shields.io/npm/dw/@salesforce/plugin-functions.svg)](https://npmjs.org/package/@salesforce/plugin-functions) [![License](https://img.shields.io/badge/License-BSD%203--Clause-brightgreen.svg)](https://raw.githubusercontent.com/salesforcecli/plugin-functions/main/LICENSE.txt)

<!-- toc -->
* [plugin-functions](#plugin-functions)
* [Usage](#usage)
* [Commands](#commands)

- [plugin-functions](#plugin-functions)
- [Usage](#usage)
- [Commands](#commands)
<!-- tocstop -->

# Usage
Expand All @@ -26,24 +27,25 @@ Now you should be able to run functions commands, e.g. `sfdx env:list`, `sfdx lo
# Commands

<!-- commands -->
* [`sf env:create:compute`](#sf-envcreatecompute)
* [`sf env:delete`](#sf-envdelete)
* [`sf env:display`](#sf-envdisplay)
* [`sf env:list`](#sf-envlist)
* [`sf env:log:tail`](#sf-envlogtail)
* [`sf env:logdrain:add`](#sf-envlogdrainadd)
* [`sf env:logdrain:list`](#sf-envlogdrainlist)
* [`sf env:logdrain:remove`](#sf-envlogdrainremove)
* [`sf env:var:get KEY`](#sf-envvarget-key)
* [`sf env:var:list`](#sf-envvarlist)
* [`sf env:var:set`](#sf-envvarset)
* [`sf env:var:unset`](#sf-envvarunset)
* [`sf generate:function`](#sf-generatefunction)
* [`sf generate:project`](#sf-generateproject)
* [`sf login:functions`](#sf-loginfunctions)
* [`sf project:deploy:functions`](#sf-projectdeployfunctions)
* [`sf run:function`](#sf-runfunction)
* [`sf run:function:start`](#sf-runfunctionstart)

- [`sf env:create:compute`](#sf-envcreatecompute)
- [`sf env:delete`](#sf-envdelete)
- [`sf env:display`](#sf-envdisplay)
- [`sf env:list`](#sf-envlist)
- [`sf env:log:tail`](#sf-envlogtail)
- [`sf env:logdrain:add`](#sf-envlogdrainadd)
- [`sf env:logdrain:list`](#sf-envlogdrainlist)
- [`sf env:logdrain:remove`](#sf-envlogdrainremove)
- [`sf env:var:get KEY`](#sf-envvarget-key)
- [`sf env:var:list`](#sf-envvarlist)
- [`sf env:var:set`](#sf-envvarset)
- [`sf env:var:unset`](#sf-envvarunset)
- [`sf generate:function`](#sf-generatefunction)
- [`sf generate:project`](#sf-generateproject)
- [`sf login:functions`](#sf-loginfunctions)
- [`sf project:deploy:functions`](#sf-projectdeployfunctions)
- [`sf run:function`](#sf-runfunction)
- [`sf run:function:start`](#sf-runfunctionstart)

## `sf env:create:compute`

Expand All @@ -56,14 +58,15 @@ USAGE
OPTIONS
-a, --setalias=setalias alias for the created environment
-o, --connected-org=connected-org username or alias for the org that the compute environment should be connected to
--json format output as json
EXAMPLES
$ sfdx env:create:compute
$ sfdx env:create:compute --setalias my-compute-environment
$ sfdx env:create:compute --connected-org my-scratch-org
```

_See code: [src/commands/env/create/compute.ts](https://github.com/salesforcecli/plugin-functions/blob/v0.2.4/src/commands/env/create/compute.ts)_
_See code: [src/commands/env/create/compute.ts](https://github.com/salesforcecli/plugin-functions/blob/v0.2.5/src/commands/env/create/compute.ts)_

## `sf env:delete`

Expand All @@ -76,13 +79,14 @@ USAGE
OPTIONS
-c, --confirm=name confirmation name
-e, --environment=environment (required) environment name
--json format output as json
EXAMPLES
$ sfdx env:delete --environment=billingApp-Scratch1
$ sfdx env:delete --environment=billingApp-Scratch1 --confirm=billingApp-Scratch1
```

_See code: [src/commands/env/delete.ts](https://github.com/salesforcecli/plugin-functions/blob/v0.2.4/src/commands/env/delete.ts)_
_See code: [src/commands/env/delete.ts](https://github.com/salesforcecli/plugin-functions/blob/v0.2.5/src/commands/env/delete.ts)_

## `sf env:display`

Expand All @@ -94,13 +98,14 @@ USAGE
OPTIONS
-e, --environment=environment (required) environment name
--json format output as json
--verbose verbose display output
EXAMPLE
$ sfdx env:display --environment=billingApp-Scratch1
```

_See code: [src/commands/env/display.ts](https://github.com/salesforcecli/plugin-functions/blob/v0.2.4/src/commands/env/display.ts)_
_See code: [src/commands/env/display.ts](https://github.com/salesforcecli/plugin-functions/blob/v0.2.5/src/commands/env/display.ts)_

## `sf env:list`

Expand All @@ -123,7 +128,7 @@ EXAMPLES
$ sfdx env:list --environment-type org --environment-type compute
```

_See code: [src/commands/env/list.ts](https://github.com/salesforcecli/plugin-functions/blob/v0.2.4/src/commands/env/list.ts)_
_See code: [src/commands/env/list.ts](https://github.com/salesforcecli/plugin-functions/blob/v0.2.5/src/commands/env/list.ts)_

## `sf env:log:tail`

Expand All @@ -135,12 +140,13 @@ USAGE
OPTIONS
-e, --environment=environment (required) environment name to retrieve logs
--json format output as json
EXAMPLE
sfdx env:log:tail --environment=billingApp-Scratch1
```

_See code: [src/commands/env/log/tail.ts](https://github.com/salesforcecli/plugin-functions/blob/v0.2.4/src/commands/env/log/tail.ts)_
_See code: [src/commands/env/log/tail.ts](https://github.com/salesforcecli/plugin-functions/blob/v0.2.5/src/commands/env/log/tail.ts)_

## `sf env:logdrain:add`

Expand All @@ -153,12 +159,13 @@ USAGE
OPTIONS
-e, --environment=environment (required) environment name
-u, --url=url (required) endpoint that will receive sent logs
--json format output as json
EXAMPLE
$ sfdx env:logdrain:add --environment=billingApp-Sandbox --url=https://example.com/drain
```

_See code: [src/commands/env/logdrain/add.ts](https://github.com/salesforcecli/plugin-functions/blob/v0.2.4/src/commands/env/logdrain/add.ts)_
_See code: [src/commands/env/logdrain/add.ts](https://github.com/salesforcecli/plugin-functions/blob/v0.2.5/src/commands/env/logdrain/add.ts)_

## `sf env:logdrain:list`

Expand All @@ -176,7 +183,7 @@ EXAMPLE
$ sfdx env:logdrain:list --environment=billingApp-Sandbox
```

_See code: [src/commands/env/logdrain/list.ts](https://github.com/salesforcecli/plugin-functions/blob/v0.2.4/src/commands/env/logdrain/list.ts)_
_See code: [src/commands/env/logdrain/list.ts](https://github.com/salesforcecli/plugin-functions/blob/v0.2.5/src/commands/env/logdrain/list.ts)_

## `sf env:logdrain:remove`

Expand All @@ -189,12 +196,13 @@ USAGE
OPTIONS
-e, --environment=environment (required) environment name
-u, --url=url (required) logdrain url to remove
--json format output as json
EXAMPLE
$ sfdx env:logdrain:remove --environment=billingApp-Sandbox --url=syslog://syslog-a.logdna.com:11137
```

_See code: [src/commands/env/logdrain/remove.ts](https://github.com/salesforcecli/plugin-functions/blob/v0.2.4/src/commands/env/logdrain/remove.ts)_
_See code: [src/commands/env/logdrain/remove.ts](https://github.com/salesforcecli/plugin-functions/blob/v0.2.5/src/commands/env/logdrain/remove.ts)_

## `sf env:var:get KEY`

Expand All @@ -206,12 +214,13 @@ USAGE
OPTIONS
-e, --environment=environment (required) environment name
--json format output as json
EXAMPLE
$ sfdx env:var:get foo --environment=my-environment
```

_See code: [src/commands/env/var/get.ts](https://github.com/salesforcecli/plugin-functions/blob/v0.2.4/src/commands/env/var/get.ts)_
_See code: [src/commands/env/var/get.ts](https://github.com/salesforcecli/plugin-functions/blob/v0.2.5/src/commands/env/var/get.ts)_

## `sf env:var:list`

Expand All @@ -223,12 +232,13 @@ USAGE
OPTIONS
-e, --environment=environment (required) environment name
--json format output as json
EXAMPLE
$ sfdx env:var:list --environment=my-environment
```

_See code: [src/commands/env/var/list.ts](https://github.com/salesforcecli/plugin-functions/blob/v0.2.4/src/commands/env/var/list.ts)_
_See code: [src/commands/env/var/list.ts](https://github.com/salesforcecli/plugin-functions/blob/v0.2.5/src/commands/env/var/list.ts)_

## `sf env:var:set`

Expand All @@ -240,12 +250,13 @@ USAGE
OPTIONS
-e, --environment=environment (required) environment name
--json format output as json
EXAMPLE
$ sfdx env:var:set foo=bar --environment=my-environment
```

_See code: [src/commands/env/var/set.ts](https://github.com/salesforcecli/plugin-functions/blob/v0.2.4/src/commands/env/var/set.ts)_
_See code: [src/commands/env/var/set.ts](https://github.com/salesforcecli/plugin-functions/blob/v0.2.5/src/commands/env/var/set.ts)_

## `sf env:var:unset`

Expand All @@ -257,12 +268,13 @@ USAGE
OPTIONS
-e, --environment=environment (required) environment name
--json format output as json
EXAMPLE
$ sfdx env:var:unset foo --environment=my-environment
```

_See code: [src/commands/env/var/unset.ts](https://github.com/salesforcecli/plugin-functions/blob/v0.2.4/src/commands/env/var/unset.ts)_
_See code: [src/commands/env/var/unset.ts](https://github.com/salesforcecli/plugin-functions/blob/v0.2.5/src/commands/env/var/unset.ts)_

## `sf generate:function`

Expand All @@ -275,6 +287,7 @@ USAGE
OPTIONS
-l, --language=(javascript|typescript|java) (required) language
-n, --name=name (required) function name
--json format output as json
ALIASES
$ sf evergreen:function:init
Expand All @@ -283,7 +296,7 @@ EXAMPLE
$ sfdx evergreen:function:create MyFunction --language=javascript
```

_See code: [src/commands/generate/function.ts](https://github.com/salesforcecli/plugin-functions/blob/v0.2.4/src/commands/generate/function.ts)_
_See code: [src/commands/generate/function.ts](https://github.com/salesforcecli/plugin-functions/blob/v0.2.5/src/commands/generate/function.ts)_

## `sf generate:project`

Expand All @@ -293,9 +306,10 @@ USAGE
OPTIONS
-n, --name=name (required) name of the generated project
--json format output as json
```

_See code: [src/commands/generate/project.ts](https://github.com/salesforcecli/plugin-functions/blob/v0.2.4/src/commands/generate/project.ts)_
_See code: [src/commands/generate/project.ts](https://github.com/salesforcecli/plugin-functions/blob/v0.2.5/src/commands/generate/project.ts)_

## `sf login:functions`

Expand All @@ -309,7 +323,7 @@ EXAMPLE
$ sfdx login:functions
```

_See code: [src/commands/login/functions.ts](https://github.com/salesforcecli/plugin-functions/blob/v0.2.4/src/commands/login/functions.ts)_
_See code: [src/commands/login/functions.ts](https://github.com/salesforcecli/plugin-functions/blob/v0.2.5/src/commands/login/functions.ts)_

## `sf project:deploy:functions`

Expand All @@ -326,9 +340,11 @@ OPTIONS
-q, --quiet limit the amount of output displayed from the deploy process
--force ignore warnings and overwrite remote repository (not allowed in production)
--json format output as json
```

_See code: [src/commands/project/deploy/functions.ts](https://github.com/salesforcecli/plugin-functions/blob/v0.2.4/src/commands/project/deploy/functions.ts)_
_See code: [src/commands/project/deploy/functions.ts](https://github.com/salesforcecli/plugin-functions/blob/v0.2.5/src/commands/project/deploy/functions.ts)_

## `sf run:function`

Expand All @@ -344,6 +360,7 @@ OPTIONS
-o, --connected-org=connected-org username or alias for the target org; overrides default target org
-p, --payload=payload set the payload of the cloudevent. also accepts @file.txt format
-s, --structured set the cloudevent to be emitted as a structured cloudevent (json)
--json format output as json
EXAMPLE
Expand All @@ -353,7 +370,7 @@ EXAMPLE
$ sfdx run:function -l http://localhost:8080 -p '{"id": 12345}' --structured
```

_See code: [src/commands/run/function.ts](https://github.com/salesforcecli/plugin-functions/blob/v0.2.4/src/commands/run/function.ts)_
_See code: [src/commands/run/function.ts](https://github.com/salesforcecli/plugin-functions/blob/v0.2.5/src/commands/run/function.ts)_

## `sf run:function:start`

Expand All @@ -369,6 +386,7 @@ OPTIONS
-p, --port=port [default: 8080] port for running the function
-v, --verbose output additional logs
--clear-cache clear associated cache before executing.
--json format output as json
--network=network Connect and build containers to a network. This can be useful to build containers which
require a local resource.
Expand All @@ -382,5 +400,6 @@ EXAMPLE
$ sfdx run:function:start --network host --no-pull --clear-cache --debug-port 9000 --port 5000
```

_See code: [src/commands/run/function/start.ts](https://github.com/salesforcecli/plugin-functions/blob/v0.2.4/src/commands/run/function/start.ts)_
_See code: [src/commands/run/function/start.ts](https://github.com/salesforcecli/plugin-functions/blob/v0.2.5/src/commands/run/function/start.ts)_

<!-- commandsstop -->
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@salesforce/plugin-functions",
"description": "Functions plugin for the SF CLI",
"version": "0.2.5",
"version": "0.2.6",
"author": "[email protected]",
"bin": {
"functions": "./bin/run"
Expand Down

0 comments on commit 0094c66

Please sign in to comment.