CodeCoverageSummary icon indicating copy to clipboard operation
CodeCoverageSummary copied to clipboard

Add ability to add summary to a section on the left (runs?) on github actions page

Open grofit opened this issue 3 years ago • 5 comments

Feature Request

It would be nice if we could output a summary on the side (not sure of the term) on github actions, much like our unit test task does image

As you can see on the left (bit I mean above) our unit test task outputs a section with the results, and it would be nice if the code coverage summary also wrote out to that section there too.

Expected Behaviour

Have a property that can be set to indicate if the summary should be output as a summary on the side

grofit avatar Aug 16 '22 10:08 grofit

Hi @grofit I've not seen that done before. Could you tell me what task you're using to get those results?

irongut avatar Aug 21 '22 21:08 irongut

Hey,

Thanks for getting back to me, its https://github.com/EnricoMi/publish-unit-test-result-action I use to get Unit Test results

grofit avatar Aug 21 '22 21:08 grofit

Thanks, it would be a nice feature so I'll see if I can work out how he's doing it.

irongut avatar Aug 21 '22 22:08 irongut

Supercharging GitHub Actions with Job Summaries

Simply output Markdown content to a new environment variable we’ve introduced called $GITHUB_STEP_SUMMARY.

Job Summary Docs

irongut avatar Aug 21 '22 22:08 irongut

@grofit As a workaround you could add the following step to your workflow after CCS:

    - name: Output to Job Summary
      run: cat code-coverage-results.md >> $GITHUB_STEP_SUMMARY

That doesn't add the item on the left but it does add the coverage to the job summary.

irongut avatar Aug 21 '22 23:08 irongut