chore(release): 1.4.0 [skip ci]

salesforcecli · Dec 5, 2024 · 8b69c38 · 8b69c38
1 parent 1ae2231
commit 8b69c38
Show file tree

Hide file tree

Showing 3 changed files with 115 additions and 21 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,17 @@
+# [1.4.0](https://github.com/salesforcecli/plugin-agent/compare/1.3.4...1.4.0) (2024-12-05)
+
+### Bug Fixes
+
+- keep up with agents lib ([75d6403](https://github.com/salesforcecli/plugin-agent/commit/75d6403b466546181db2b697163b5b1b689a2266))
+- messages ([38eef81](https://github.com/salesforcecli/plugin-agent/commit/38eef81f144739596fc696eccb7264d55cffb6e6))
+
+### Features
+
+- add command stubs ([3f942b2](https://github.com/salesforcecli/plugin-agent/commit/3f942b22aed7d532f3243654292809af07dfb592))
+- implement agent test run ([81ec3a3](https://github.com/salesforcecli/plugin-agent/commit/81ec3a3d3fb253e8d721881dfba7fb0036323e84))
+- show completion progress ([4da8b5f](https://github.com/salesforcecli/plugin-agent/commit/4da8b5f667a08f27b300e495be09204770acd7e5))
+- show passing and failing tests ([e422ca5](https://github.com/salesforcecli/plugin-agent/commit/e422ca5436a9dc03fe42c8aef50486be6b8ddfd1))
+
 ## [1.3.4](https://github.com/salesforcecli/plugin-agent/compare/1.3.3...1.3.4) (2024-12-03)
 
 ### Bug Fixes

diff --git a/README.md b/README.md
@@ -64,6 +64,8 @@ sf plugins
 - [`sf agent create`](#sf-agent-create)
 - [`sf agent generate spec`](#sf-agent-generate-spec)
 - [`sf agent test cancel`](#sf-agent-test-cancel)
+- [`sf agent test results`](#sf-agent-test-results)
+- [`sf agent test resume`](#sf-agent-test-resume)
 - [`sf agent test run`](#sf-agent-test-run)
 
 ## `sf agent create`
@@ -102,7 +104,7 @@ FLAG DESCRIPTIONS
     spec` command.
 ```
 
-_See code: [src/commands/agent/create.ts](https://github.com/salesforcecli/plugin-agent/blob/1.3.4/src/commands/agent/create.ts)_
+_See code: [src/commands/agent/create.ts](https://github.com/salesforcecli/plugin-agent/blob/1.4.0/src/commands/agent/create.ts)_
 
 ## `sf agent generate spec`
 
@@ -145,21 +147,22 @@ EXAMPLES
       --company-description "A meaningful description"
 ```
 
-_See code: [src/commands/agent/generate/spec.ts](https://github.com/salesforcecli/plugin-agent/blob/1.3.4/src/commands/agent/generate/spec.ts)_
+_See code: [src/commands/agent/generate/spec.ts](https://github.com/salesforcecli/plugin-agent/blob/1.4.0/src/commands/agent/generate/spec.ts)_
 
 ## `sf agent test cancel`
 
 Cancel a running test for an Agent.
 
 ```
 USAGE
-  $ sf agent test cancel -o <value> -i <value> [--json] [--flags-dir <value>] [-r]
+  $ sf agent test cancel -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-i <value>] [-r]
 
 FLAGS
-  -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.
-  -r, --use-most-recent     Use the job ID of the most recent test evaluation.
+  -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.
+  -r, --use-most-recent      Use the job ID of the most recent test evaluation.
+      --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.
@@ -173,26 +176,103 @@ DESCRIPTION
 EXAMPLES
   Cancel a test for an Agent:
 
-    $ sf agent test cancel --id AiEvalId
+    $ 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)_
+
+## `sf agent test results`
+
+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]
+
+FLAGS
+  -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>
+
+GLOBAL FLAGS
+  --flags-dir=<value>  Import flag values from a directory.
+  --json               Format output as json.
+
+DESCRIPTION
+  Get the results of a test evaluation.
+
+  Provide the AiEvaluation ID to get the results of a test evaluation.
+
+EXAMPLES
+  $ sf agent test results --job-id AiEvalId
+```
+
+_See code: [src/commands/agent/test/results.ts](https://github.com/salesforcecli/plugin-agent/blob/1.4.0/src/commands/agent/test/results.ts)_
+
+## `sf agent test resume`
+
+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]
+
+FLAGS
+  -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.
+  -r, --use-most-recent         Use the job ID of the most recent test evaluation.
+  -w, --wait=<value>            [default: 5 minutes] 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>
+
+GLOBAL FLAGS
+  --flags-dir=<value>  Import flag values from a directory.
+  --json               Format output as json.
+
+DESCRIPTION
+  Resume a running test for an Agent.
+
+  Resume a running test for an Agent, providing the AiEvaluation ID.
+
+EXAMPLES
+  Resume a test for an Agent:
+
+    $ sf agent test resume --job-id AiEvalId
+
+FLAG DESCRIPTIONS
+  -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/cancel.ts](https://github.com/salesforcecli/plugin-agent/blob/1.3.4/src/commands/agent/test/cancel.ts)_
+_See code: [src/commands/agent/test/resume.ts](https://github.com/salesforcecli/plugin-agent/blob/1.4.0/src/commands/agent/test/resume.ts)_
 
 ## `sf agent test run`
 
 Start a test for an Agent.
 
 ```
 USAGE
-  $ sf agent test run -o <value> -i <value> [--json] [--flags-dir <value>] [-w <value>] [-d <value>]
+  $ sf agent test run -o <value> -n <value> [--json] [--flags-dir <value>] [--api-version <value>] [-w <value>]
+    [--result-format json|human]
 
 FLAGS
-  -d, --output-dir=<value>  Directory in which to store test run files.
-  -i, --id=<value>          (required) The AiEvalDefinitionVersion ID.
-  -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.
+  -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>
 
 GLOBAL FLAGS
   --flags-dir=<value>  Import flag values from a directory.
@@ -206,18 +286,18 @@ DESCRIPTION
 EXAMPLES
   Start a test for an Agent:
 
-    $ sf agent test run --id AiEvalDefVerId
+    $ sf agent test run --name AiEvalDefVerId
 
 FLAG DESCRIPTIONS
-  -i, --id=<value>  The AiEvalDefinitionVersion ID.
+  -n, --name=<value>  The name of the AiEvaluationDefinition to start.
 
-    The AiEvalDefinitionVersion ID.
+    The name of the AiEvaluationDefinition to start.
 
   -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/run.ts](https://github.com/salesforcecli/plugin-agent/blob/1.3.4/src/commands/agent/test/run.ts)_
+_See code: [src/commands/agent/test/run.ts](https://github.com/salesforcecli/plugin-agent/blob/1.4.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.3.4",
+  "version": "1.4.0",
   "author": "Salesforce",
   "bugs": "https://github.com/forcedotcom/cli/issues",
   "dependencies": {