Skip to content

Commit aca8561

Browse files
authored
docs: Clarify version requirements for workflow_dispatch and push events (#704)
1 parent f55c214 commit aca8561

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,10 @@ The provided link opens the promptfoo web viewer, which allows you to interactiv
1414

1515
This action supports multiple GitHub event types:
1616
- **Pull Request** (`pull_request`, `pull_request_target`) - Compares changes between base and head branches
17-
- **Push** (`push`) - Compares changes between commits
18-
- **Manual Trigger** (`workflow_dispatch`) - Allows manual evaluation with custom inputs
17+
- **Push** (`push`) - Compares changes between commits *(requires v1.1.0+)*
18+
- **Manual Trigger** (`workflow_dispatch`) - Allows manual evaluation with custom inputs *(requires v1.1.0+)*
19+
20+
> **Note:** Version v1.0.0 only supports `pull_request` events. To use `push` or `workflow_dispatch` events, please use `@v1` (which now points to v1.1.0+) or explicitly use `@v1.1.0`.
1921
2022
## Configuration
2123

@@ -94,7 +96,7 @@ jobs:
9496
${{ runner.os }}-promptfoo-
9597
9698
- name: Run promptfoo evaluation
97-
uses: promptfoo/promptfoo-action@main
99+
uses: promptfoo/promptfoo-action@v1
98100
with:
99101
openai-api-key: ${{ secrets.OPENAI_API_KEY }}
100102
github-token: ${{ secrets.GITHUB_TOKEN }}
@@ -222,7 +224,7 @@ jobs:
222224
- uses: actions/checkout@v4
223225
224226
- name: Run promptfoo evaluation
225-
uses: promptfoo/promptfoo-action@main
227+
uses: promptfoo/promptfoo-action@v1
226228
with:
227229
openai-api-key: ${{ secrets.OPENAI_API_KEY }}
228230
github-token: ${{ secrets.GITHUB_TOKEN }}
@@ -349,7 +351,7 @@ jobs:
349351
${{ runner.os }}-promptfoo-
350352
351353
- name: Run promptfoo evaluation
352-
uses: promptfoo/promptfoo-action@main
354+
uses: promptfoo/promptfoo-action@v1
353355
with:
354356
github-token: ${{ secrets.GITHUB_TOKEN }}
355357
openai-api-key: ${{ secrets.OPENAI_API_KEY }}
@@ -397,7 +399,7 @@ The action provides cache statistics as outputs:
397399
```yaml
398400
- name: Run evaluation
399401
id: eval
400-
uses: promptfoo/promptfoo-action@main
402+
uses: promptfoo/promptfoo-action@v1
401403
with:
402404
github-token: ${{ secrets.GITHUB_TOKEN }}
403405
config: 'promptfooconfig.yaml'
@@ -424,7 +426,7 @@ If caching isn't working as expected:
424426

425427
1. **Enable debug mode** to see cache hits/misses:
426428
```yaml
427-
- uses: promptfoo/promptfoo-action@main
429+
- uses: promptfoo/promptfoo-action@v1
428430
with:
429431
debug: true
430432
```
@@ -453,7 +455,7 @@ To enable sharing with authentication:
453455

454456
```yaml
455457
- name: Run promptfoo evaluation
456-
uses: promptfoo/promptfoo-action@main
458+
uses: promptfoo/promptfoo-action@v1
457459
env:
458460
PROMPTFOO_API_KEY: ${{ secrets.PROMPTFOO_API_KEY }}
459461
with:
@@ -467,7 +469,7 @@ To explicitly disable sharing:
467469

468470
```yaml
469471
- name: Run promptfoo evaluation
470-
uses: promptfoo/promptfoo-action@main
472+
uses: promptfoo/promptfoo-action@v1
471473
with:
472474
github-token: ${{ secrets.GITHUB_TOKEN }}
473475
config: 'promptfooconfig.yaml'

0 commit comments

Comments
 (0)