Support Markdown formatted output.

[jeschkies]

Since GitHub Actions support job summaries it would be nice to support a Markdown formatted summary.

[dnephin]

Thank you for the feature suggestion! Job summaries (docs) seem like a great feature.

It looks like these summaries are printed separately from the test output, so the way I think this should work is something along these lines:

• gotestsum should print its summary as it does today to the regular step output
• if the GITHUB_STEP_SUMMARY environment variable is set to the path of a file that exists, write a markdown summary to that file
• add a new flag to specify what the summary should look like, or to disable it entirely. I imagine that flag would work similar to the existing --hide-summary flag, but that will depend on exactly what's in the summary.

For the contents of the markdown summary, I guess it would be pretty similar to the existing summary, except maybe in reverse. Start with a DONE line that has counts of tests pass/fail/skipped/error/total. Followed by sections for errors, then failed output , and finally skipped test output. If the summary supports collapsed sections that might be nice to hide the full output by default, or maybe only when the output is longer than ~10 lines.

Anything else we could include in that summary?

[jeschkies]

Start with a DONE line that has counts of tests pass/fail/skipped/error/total. Followed by sections for errors, then failed output , and finally skipped test output.

That sounds pretty good to me.

As for where to write the summary I'm not sure. Now that you've mentioned it it seems like a separate output. Would an option like --summary-output-path $GITHUB_STEP_SUMMARY make sense?

[afbjorklund]

You can use go-test-report, to generate markdown (and HTML) summaries

• Suggestion: Export to Markdown vakenbolt/go-test-report#38

There is a related issue on how to make the tools co-operation better, and a request to move the project to gotest.tools

• Advocate gotestsum for running go test vakenbolt/go-test-report#61