feat: make prompts parameter optional (#108)

* feat: make `prompts` parameter optional * merge main * rebuild --------- Co-authored-by: Michael D'Angelo <[email protected]>
promptfoo · Sep 12, 2024 · cb2158d · cb2158d
1 parent 4084a12
commit cb2158d
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -16,12 +16,12 @@ The action can be configured using the following inputs:
 
 | Parameter            | Description                                                                                                               | Required |
 | -------------------- | ------------------------------------------------------------------------------------------------------------------------- | -------- |
-| `github-token`       | The Github token. Used to authenticate requests to the Github API.                                                        | Yes      |
-| `prompts`            | The glob patterns for the prompt files. These patterns are used to find the prompt files that the action should evaluate. | Yes      |
 | `config`             | The path to the configuration file. This file contains settings for the action.                                           | Yes      |
+| `github-token`       | The Github token. Used to authenticate requests to the Github API.                                                        | Yes      |
 | `cache-path`         | The path to the cache. This is where the action stores temporary data.                                                    | No       |
-| `promptfoo-version`  | The version of promptfoo to use. Defaults to `latest`                                                                     | No       |
 | `no-share`           | No sharing option for promptfoo. Defaults to `false`                                                                      | No       |
+| `promptfoo-version`  | The version of promptfoo to use. Defaults to `latest`                                                                     | No       |
+| `prompts`            | The glob patterns for the prompt files. These patterns are used to find the prompt files that the action should evaluate. | No       |
 | `use-config-prompts` | Use prompt files set at config file. Defaults to `false`                                                                  | No       |
 
 The following API key parameters are supported:
@@ -71,7 +71,6 @@ jobs:
         with:
           openai-api-key: ${{ secrets.OPENAI_API_KEY }}
           github-token: ${{ secrets.GITHUB_TOKEN }}
-          prompts: 'prompts/**/*.json'
           config: 'prompts/promptfooconfig.yaml'
           cache-path: ~/.cache/promptfoo
 ```

diff --git a/dist/index.js b/dist/index.js
diff --git a/src/main.ts b/src/main.ts
@@ -41,7 +41,7 @@ export async function run(): Promise<void> {
     });
     const githubToken: string = core.getInput('github-token', {required: true});
     const promptFilesGlobs: string[] = core
-      .getInput('prompts', {required: true})
+      .getInput('prompts', {required: false})
       .split('\n');
     const configPath: string = core.getInput('config', {
       required: true,