Skip to content

Commit

Permalink
chore: add title to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Ma11hewThomas committed Jan 15, 2025
1 parent c791fe2 commit 38c619b
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 43 deletions.
32 changes: 0 additions & 32 deletions .github/workflows/community.yaml

This file was deleted.

17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,7 @@ There are several inputs available
# Behavior Options
summary: false # Post report to the job summary. Default is true
pull-request: false # Comment on pull request with report. Default is false
title: '' # Set a custom title to display on the report.
annotate: false # Add failed test annotations. Default is true
on-fail-only: false # Add a pull request comment only if tests fail. Default is false
exit-on-fail: false # Exit the workflow with a failure status if any tests fail. Default is false
Expand All @@ -131,8 +132,8 @@ There are several inputs available
comment-tag: false # Tag to match Pull Request comment
# Advanced Options
artifact-name: false # Name of the artifact containing test reports. Default is ctrf-report
previous-results-max: false # Maximum number of previous test results to display in the report. Default is 10
artifact-name: 'ctrf-report' # Name of the artifact containing test reports. Default is ctrf-report
previous-results-max: 10 # Maximum number of previous test results to display in the report. Default is 10
fetch-previous-results: false # Always fetch previous workflow runs when using custom templates. Default is false
group-by: 'filePath' # Specify grouping for applicable reports (e.g., suite or file path). Default is filePath
always-group-by: false # Force grouping by suite or file path for all reports. Default is false
Expand Down Expand Up @@ -227,12 +228,11 @@ Add the following to your workflow file:
if: always()
```

For detailed instructions on building your own reports, see the
For detailed instructions on building your own report, see the
[documentation](docs/build-your-own-report.md).

For inspiration, check out the [built-in reports](src/reports),
[community reports](community-reports) and an
[example](templates/custom-report.hbs)
For inspiration, check out the [built-in reports](src/reports) and
[community reports](community-reports)

## Community Reports

Expand All @@ -241,8 +241,9 @@ reports allow users to share custom reports designed for specific use cases.

To submit a community-built report create a Pull Request.

You can use reports [community built reports](community-reports) by adding the
following to your workflow file:
You can see available [community built reports](community-reports)

Add the following to your workflow file:

```yaml
- name: Publish Test Report
Expand Down
5 changes: 2 additions & 3 deletions action.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
name: 'tbc'
name: 'test-reports'
description:
'A GitHub Action to build test reports and publish to job summaries and pull
requests.'
'Build, publish and view test reports on job summaries and pull requests'
author: 'ctrf-io'

branding:
Expand Down

0 comments on commit 38c619b

Please sign in to comment.