Skip to content

Commit d648b1f

Browse files
authored
docs: update summary params (#77)
1 parent fec1f76 commit d648b1f

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

docs/advanced-configurations.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ include-warnings: true
4040
4141
## GitHub Summary Page
4242
43-
To view a summary of the results produced by NowSecure in the workflow, enable the top-level `summary` option in the `.nsconfig.yml`.
43+
To view a summary of the results produced by NowSecure in the workflow, set the top-level `summary` option in the `.nsconfig.yml`. Valid options are, `none`, `short`, and `long`.
4444

4545
For example:
4646

@@ -49,7 +49,7 @@ filter:
4949
example-filter:
5050
# ...
5151
# Remainder of configuration...
52-
summary: true
52+
summary: short
5353
```
5454

5555
For more information on GitHub Action summaries, see GitHub's [blog post](https://github.blog/2022-05-09-supercharging-github-actions-with-job-summaries/).

0 commit comments

Comments
 (0)