chore(release): 1.5.0 [skip ci]

salesforcecli · Dec 10, 2024 · 3ad317d · 3ad317d
1 parent 0af5887
commit 3ad317d
Show file tree

Hide file tree

Showing 3 changed files with 74 additions and 13 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,9 @@
+# [1.5.0](https://github.com/salesforcecli/plugin-agent/compare/1.4.0...1.5.0) (2024-12-10)
+
+### Features
+
+- junit result formatter ([af485da](https://github.com/salesforcecli/plugin-agent/commit/af485dada1894756f2b5271e2a0ae01d51acfc78))
+
 # [1.4.0](https://github.com/salesforcecli/plugin-agent/compare/1.3.4...1.4.0) (2024-12-05)
 
 ### Bug Fixes

diff --git a/README.md b/README.md
@@ -63,6 +63,7 @@ sf plugins
 
 - [`sf agent create`](#sf-agent-create)
 - [`sf agent generate spec`](#sf-agent-generate-spec)
+- [`sf agent preview`](#sf-agent-preview)
 - [`sf agent test cancel`](#sf-agent-test-cancel)
 - [`sf agent test results`](#sf-agent-test-results)
 - [`sf agent test resume`](#sf-agent-test-resume)
@@ -104,7 +105,7 @@ FLAG DESCRIPTIONS
     spec` command.
 ```
 
-_See code: [src/commands/agent/create.ts](https://github.com/salesforcecli/plugin-agent/blob/1.4.0/src/commands/agent/create.ts)_
+_See code: [src/commands/agent/create.ts](https://github.com/salesforcecli/plugin-agent/blob/1.5.0/src/commands/agent/create.ts)_
 
 ## `sf agent generate spec`
 
@@ -147,7 +148,42 @@ EXAMPLES
       --company-description "A meaningful description"
 ```
 
-_See code: [src/commands/agent/generate/spec.ts](https://github.com/salesforcecli/plugin-agent/blob/1.4.0/src/commands/agent/generate/spec.ts)_
+_See code: [src/commands/agent/generate/spec.ts](https://github.com/salesforcecli/plugin-agent/blob/1.5.0/src/commands/agent/generate/spec.ts)_
+
+## `sf agent preview`
+
+Interact with an active agent, as a user would, to preview responses
+
+```
+USAGE
+  $ sf agent preview -o <value> -n <value> [--flags-dir <value>] [--api-version <value>]
+
+FLAGS
+  -n, --name=<value>         (required) The name of the agent you want to preview
+  -o, --target-org=<value>   (required) Username or alias of the target org. Not required if the `target-org`
+                             configuration variable is already set.
+      --api-version=<value>  Override the api version used for api requests made by this command
+
+GLOBAL FLAGS
+  --flags-dir=<value>  Import flag values from a directory.
+
+DESCRIPTION
+  Interact with an active agent, as a user would, to preview responses
+
+  XXX
+
+EXAMPLES
+  $ sf agent preview --agent HelpDeskAgent
+
+  $ sf agent preview --agent ConciergeAgent --target-org production
+
+FLAG DESCRIPTIONS
+  -n, --name=<value>  The name of the agent you want to preview
+
+    the API name of the agent? (TBD based on agents library)
+```
+
+_See code: [src/commands/agent/preview.ts](https://github.com/salesforcecli/plugin-agent/blob/1.5.0/src/commands/agent/preview.ts)_
 
 ## `sf agent test cancel`
 
@@ -179,7 +215,7 @@ EXAMPLES
     $ sf agent test cancel --job-id AiEvalId
 ```
 
-_See code: [src/commands/agent/test/cancel.ts](https://github.com/salesforcecli/plugin-agent/blob/1.4.0/src/commands/agent/test/cancel.ts)_
+_See code: [src/commands/agent/test/cancel.ts](https://github.com/salesforcecli/plugin-agent/blob/1.5.0/src/commands/agent/test/cancel.ts)_
 
 ## `sf agent test results`
 
@@ -188,15 +224,16 @@ Get the results of a test evaluation.
 ```
 USAGE
   $ sf agent test results -o <value> -i <value> [--json] [--flags-dir <value>] [--api-version <value>] [--result-format
-    json|human]
+    json|human|junit] [-f <value>]
 
 FLAGS
+  -f, --output-dir=<value>      Directory to write the test results to.
   -i, --job-id=<value>          (required) The AiEvaluation ID.
   -o, --target-org=<value>      (required) Username or alias of the target org. Not required if the `target-org`
                                 configuration variable is already set.
       --api-version=<value>     Override the api version used for api requests made by this command
       --result-format=<option>  [default: human] Format of the test run results.
-                                <options: json|human>
+                                <options: json|human|junit>
 
 GLOBAL FLAGS
   --flags-dir=<value>  Import flag values from a directory.
@@ -209,9 +246,15 @@ DESCRIPTION
 
 EXAMPLES
   $ sf agent test results --job-id AiEvalId
+
+FLAG DESCRIPTIONS
+  -f, --output-dir=<value>  Directory to write the test results to.
+
+    If test run is complete, write the results to the specified directory. If the tests are still running, the test
+    results will not be written.
 ```
 
-_See code: [src/commands/agent/test/results.ts](https://github.com/salesforcecli/plugin-agent/blob/1.4.0/src/commands/agent/test/results.ts)_
+_See code: [src/commands/agent/test/results.ts](https://github.com/salesforcecli/plugin-agent/blob/1.5.0/src/commands/agent/test/results.ts)_
 
 ## `sf agent test resume`
 
@@ -220,9 +263,10 @@ Resume a running test for an Agent.
 ```
 USAGE
   $ sf agent test resume -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-i <value>] [-r] [-w
-    <value>] [--result-format json|human]
+    <value>] [--result-format json|human|junit] [-f <value>]
 
 FLAGS
+  -f, --output-dir=<value>      Directory to write the test results to.
   -i, --job-id=<value>          The AiEvaluation ID.
   -o, --target-org=<value>      (required) Username or alias of the target org. Not required if the `target-org`
                                 configuration variable is already set.
@@ -231,7 +275,7 @@ FLAGS
                                 results to the terminal window.
       --api-version=<value>     Override the api version used for api requests made by this command
       --result-format=<option>  [default: human] Format of the test run results.
-                                <options: json|human>
+                                <options: json|human|junit>
 
 GLOBAL FLAGS
   --flags-dir=<value>  Import flag values from a directory.
@@ -248,12 +292,17 @@ EXAMPLES
     $ sf agent test resume --job-id AiEvalId
 
 FLAG DESCRIPTIONS
+  -f, --output-dir=<value>  Directory to write the test results to.
+
+    If test run is complete, write the results to the specified directory. If the tests are still running, the test
+    results will not be written.
+
   -w, --wait=<value>  Number of minutes to wait for the command to complete and display results to the terminal window.
 
     If the command continues to run after the wait period, the CLI returns control of the terminal window to you.
 ```
 
-_See code: [src/commands/agent/test/resume.ts](https://github.com/salesforcecli/plugin-agent/blob/1.4.0/src/commands/agent/test/resume.ts)_
+_See code: [src/commands/agent/test/resume.ts](https://github.com/salesforcecli/plugin-agent/blob/1.5.0/src/commands/agent/test/resume.ts)_
 
 ## `sf agent test run`
 
@@ -262,17 +311,18 @@ Start a test for an Agent.
 ```
 USAGE
   $ sf agent test run -o <value> -n <value> [--json] [--flags-dir <value>] [--api-version <value>] [-w <value>]
-    [--result-format json|human]
+    [--result-format json|human|junit] [-f <value>]
 
 FLAGS
+  -f, --output-dir=<value>      Directory to write the test results to.
   -n, --name=<value>            (required) The name of the AiEvaluationDefinition to start.
   -o, --target-org=<value>      (required) Username or alias of the target org. Not required if the `target-org`
                                 configuration variable is already set.
   -w, --wait=<value>            Number of minutes to wait for the command to complete and display results to the
                                 terminal window.
       --api-version=<value>     Override the api version used for api requests made by this command
       --result-format=<option>  [default: human] Format of the test run results.
-                                <options: json|human>
+                                <options: json|human|junit>
 
 GLOBAL FLAGS
   --flags-dir=<value>  Import flag values from a directory.
@@ -289,6 +339,11 @@ EXAMPLES
     $ sf agent test run --name AiEvalDefVerId
 
 FLAG DESCRIPTIONS
+  -f, --output-dir=<value>  Directory to write the test results to.
+
+    If test run is complete, write the results to the specified directory. If the tests are still running, the test
+    results will not be written.
+
   -n, --name=<value>  The name of the AiEvaluationDefinition to start.
 
     The name of the AiEvaluationDefinition to start.
@@ -298,6 +353,6 @@ FLAG DESCRIPTIONS
     If the command continues to run after the wait period, the CLI returns control of the terminal window to you.
 ```
 
-_See code: [src/commands/agent/test/run.ts](https://github.com/salesforcecli/plugin-agent/blob/1.4.0/src/commands/agent/test/run.ts)_
+_See code: [src/commands/agent/test/run.ts](https://github.com/salesforcecli/plugin-agent/blob/1.5.0/src/commands/agent/test/run.ts)_
 
 <!-- commandsstop -->
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@salesforce/plugin-agent",
   "description": "Commands to interact with Salesforce agents",
-  "version": "1.4.0",
+  "version": "1.5.0",
   "author": "Salesforce",
   "bugs": "https://github.com/forcedotcom/cli/issues",
   "dependencies": {