Skip to content

Commit

Permalink
Notify about stdout limitation on step outputs
Browse files Browse the repository at this point in the history
  • Loading branch information
nikola-jokic committed Mar 1, 2024
1 parent 772a27b commit b84aea6
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions content/1.workflows/1.syntax.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,11 @@ If the step fails, the job fails. Failure of the step is based on the exit code

If step fails, the `stderr` is going to be displayed on the UI.

::alert{type="info"}
The step output endpoint is limited to 2MiB. However, the result endpoint is limited to 100MiB. So if the output of your tool is larger than 2MiB,
you should avoid writing it to the `stdout`.
::

### `scans[].steps[].run`

Run specifies a script to be executed. It is written to a temporary file on the disk and executed by a shell script specified in `scans[].steps[].shell`.
Expand All @@ -127,7 +132,6 @@ The script lives only during the step. It will be cleaned up after each step.

To write a script, you can use template evaluation syntax. To read more about that, please visit "Template evaluation" section.

::alert{type="note"}
There may be situations where workflow syntax looks valid, but the server fails to parse it.

For example:
Expand All @@ -142,7 +146,6 @@ To fix this problem, you can do the following:
sleep $((sleep_time > 0 ? sleep_time : 0)); echo "test"
shell: bash
```
::

### `scans[].steps[].shell`

Expand Down

0 comments on commit b84aea6

Please sign in to comment.