Skip to content

Commit

Permalink
Update action input docs
Browse files Browse the repository at this point in the history
  • Loading branch information
daun committed Jul 8, 2024
1 parent 6ff0f36 commit ae24742
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 11 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,29 +56,29 @@ jobs:
# Path to the JSON report file generated by Playwright. Required.
report-file: 'result.json'

# URL to a published html report, uploaded by another action in a previous step.
# Example pipeline: https://playwright.dev/docs/test-sharding#publishing-report-on-the-web
report-url: 'https://user.github.io/repo/yyyy-mm-dd-id/'

# A unique tag to represent this report when reporting on multiple test runs
# Defaults to the current workflow name
report-tag: ''

# URL to a published html report, uploaded by another action in a previous step.
# Example pipeline: https://playwright.dev/docs/test-sharding#publishing-report-on-the-web
report-url: 'https://user.github.io/repo/yyyy-mm-dd-id/'

# Title/headline to use for the created pull request comment.
# Default: Playwright test results
comment-title: 'Results'
comment-title: 'Test results'

# Additional information to include in the summary comment, markdown-formatted
# Default: ''
custom-info: 'For more information, see our [end-to-end test readme](link)'
custom-info: 'For more information, [see our readme](http://link)'

# Create a job summary comment for the workflow run
# Default: false
job-summary: true
job-summary: false

# Icon style to use: octicons | emojis
# Default: octicons
icon-style: 'emojis'
icon-style: 'octicons'
```
## Output
Expand Down
9 changes: 6 additions & 3 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,19 @@ inputs:
report-file:
description: 'Path to the generated json report file'
required: true
report-url:
description: 'URL to the generated html report, if uploaded'
required: false
report-tag:
description: 'Tag reports to distinguish test runs in the same workflow instead of overwriting'
required: false
report-url:
description: 'URL to the generated html report, if uploaded'
required: false
comment-title:
description: 'Customize the title of the pull request comment'
required: false
default: 'Playwright test results'
custom-info:
description: 'Additional information to include in the summary comment, markdown-formatted'
required: false
job-summary:
description: 'Create a job summary comment for the workflow run'
required: false
Expand Down

0 comments on commit ae24742

Please sign in to comment.