From c92d096bd6124b2608a8a7efbde005907a5e97f8 Mon Sep 17 00:00:00 2001 From: svc-cli-bot Date: Sun, 24 Mar 2024 08:44:35 +0000 Subject: [PATCH] chore(release): 3.0.72 [skip ci] --- CHANGELOG.md | 6 +++++ README.md | 71 +++------------------------------------------------- package.json | 2 +- 3 files changed, 10 insertions(+), 69 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 97911b33..517a36a6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,9 @@ +## [3.0.72](https://github.com/salesforcecli/plugin-command-reference/compare/3.0.71...3.0.72) (2024-03-24) + +### Bug Fixes + +- **deps:** bump @salesforce/core from 6.7.1 to 6.7.3 ([61cd73a](https://github.com/salesforcecli/plugin-command-reference/commit/61cd73a72c350416c98d191edc04c4c7ca18d3b8)) + ## [3.0.71](https://github.com/salesforcecli/plugin-command-reference/compare/3.0.70...3.0.71) (2024-03-17) ### Bug Fixes diff --git a/README.md b/README.md index ca9def0d..73c1cf45 100644 --- a/README.md +++ b/README.md @@ -81,74 +81,9 @@ Now diff the output. Changes should be intentional! -- [`sf commandreference generate`](#sf-commandreference-generate) -- [`sf jit install`](#sf-jit-install) +# Command Topics -## `sf commandreference generate` - -generate the command reference guide located - -``` -USAGE - $ sf commandreference generate [--json] [-d ] [-p | -a] [-s ] [--hidden] [--error-on-warnings] [-c - ] - -FLAGS - -a, --all include all relevant plugins in the generation - -c, --config-path= A path to the directory containing a plugin or cli - -d, --output-dir= [default: ./tmp/root] output directory to put generated files - -p, --plugins=... comma separated list of plugin names to be part of the generation. Defaults to the oclif - plugin in the current working directory - -s, --ditamap-suffix= [default: unified] unique suffix to append to generated ditamap - --error-on-warnings fail the command if there are any warnings - --hidden show hidden commands - -GLOBAL FLAGS - --json Format output as json. - -DESCRIPTION - generate the command reference guide located - - generate the command reference guide located - -EXAMPLES - Generate the command reference guide - - $ sf commandreference generate - - Generate the command reference for a set of plugins - - $ sf commandreference generate --plugins pluginA,pluginB - - Generate the command reference for all plugins - - $ sf commandreference generate --all --output-dir ./docs - - Generate the command reference for all plugins in a directory - - $ sf commandreference generate --all --config-path /path/to/plugin --output-dir ./docs -``` - -_See code: [src/commands/commandreference/generate.ts](https://github.com/salesforcecli/plugin-command-reference/blob/3.0.71/src/commands/commandreference/generate.ts)_ - -## `sf jit install` - -Install all JIT plugins. - -``` -USAGE - $ sf jit install [--json] [-d] - -FLAGS - -d, --dry-run List the plugins that would be installed. - -GLOBAL FLAGS - --json Format output as json. - -EXAMPLES - $ sf jit install -``` - -_See code: [src/commands/jit/install.ts](https://github.com/salesforcecli/plugin-command-reference/blob/3.0.71/src/commands/jit/install.ts)_ +- [`sf commandreference`](docs/commandreference.md) - generate the Salesforce CLI command reference guide. +- [`sf jit`](docs/jit.md) - description for jit diff --git a/package.json b/package.json index b0b556fa..f5b2b58b 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "@salesforce/plugin-command-reference", "description": "Generate the Salesforce CLI command reference guide", - "version": "3.0.71", + "version": "3.0.72", "author": "Salesforce", "bugs": "https://github.com/salesforcecli/plugin-command-reference/issues", "dependencies": {