Skip to content

Commit b28bbe9

Browse files
committed
Update Handlebars helpers documentation and correct GitHub properties reference
1 parent 4aa364e commit b28bbe9

File tree

1 file changed

+3
-11
lines changed

1 file changed

+3
-11
lines changed

docs/build-your-own-report.md

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -102,20 +102,12 @@ to dynamically generate content based on your test results.
102102

103103
## Helpers
104104

105-
When writing your template, you can use several Handlebars helpers:
106-
107-
- `{{countFlaky ctrf.tests}}`: Counts and returns the number of flaky tests.
108-
109-
- `{{formatDurationFromTimes ctrf.summary.start ctrf.summary.stop}}`: Formats the
110-
duration between start and stop times into a human-readable string.
111-
112-
- `{{stripAnsi message}}`: Strips ANSI from string, useful for when error
113-
messages contain ANSI characters.
105+
When writing your template, you can use Handlebars helpers:
114106

115107
- `{{eq arg1 arg2}}`: Compares two arguments and returns true if they are equal.
116108

117109
See available helpers
118-
[here](https://github.com/ctrf-io/github-test-reporter/tree/main/src/handlebars/helpers).
110+
[here](https://github.com/ctrf-io/handlebars-helpers-ctrf).
119111

120112
We welcome contributions for additional helpers.
121113

@@ -154,7 +146,7 @@ Example accessing test data:
154146
## GitHub Properties
155147

156148
GitHub properties are made available to use in your template. You can access
157-
these properties `github` property, for example `github.repoName`
149+
these properties by using the `github` property, for example `github.repoName`
158150

159151
You can access the entire context via the `github.context` property.
160152

0 commit comments

Comments
 (0)