Skip to main content

Markdown Summary Formatter

The Markdown Summary formatter outputs a short summary of your tests results in Markdown format. It is designed to be used with Github Actions job summaries.

At the moment, it just reports how many tests failed (if any) and how long the tests took to run. Below is an example in GitHub Actions.

Job summary example

Usage​

To use it, just pass the --markdown-summary argument with a file path. The tests will write the Markdown summary to this path.

Within GitHub Actions, you can pass the GITHUB_STEP_SUMMARY variable.

stack run your-tests -- \
   ... \
   --markdown-summary $GITHUB_STEP_SUMMARY