Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

$GITHUB_STEP_SUMMARY support #780

Open
hitmands opened this issue Oct 15, 2024 · 1 comment
Open

$GITHUB_STEP_SUMMARY support #780

hitmands opened this issue Oct 15, 2024 · 1 comment
Assignees
Labels
enhancement New feature or request question Further information is requested

Comments

@hitmands
Copy link

Is your feature request related to a problem? Please describe.
It would be helpful to output a summary of the test coverage as ${GITHUB_STEP_SUMMARY} so
people could use a quick glance at how things went during the test run.

Describe the solution you'd like

- name: Unit Testing (Coverage)
  uses: paambaati/[email protected]
  env:
    CC_TEST_REPORTER_ID: ${{ secrets.CODE_CLIMATE_TOKEN }}
  with:
    summary: true
    coverageCommand: yarn test --coverage
    coverageLocations: |
       ${{ github.workspace }}/package-one/*/dist/vitest-coverage/lcov.info:lcov
       ${{ github.workspace }}/package-two/*/dist/vitest-coverage/lcov.info:lcov
echo "${{ combined_coverage }}" >> $GITHUB_STEP_SUMMARY

Describe alternatives you've considered
Alternatively, just output the combined coverage, and leave it to the
user to direct the output somewhere

${{ steps.coverage.outputs.report }}

Additional context

  • Coverage should be combined to allow for monorepos and partial coverage files
  • The output should either be markdown, or json, to easily consume it
@hitmands hitmands added the enhancement New feature or request label Oct 15, 2024
@paambaati
Copy link
Owner

@hitmands Can you show me what an ideal output should look like? The tool only passes on the coverage output files to CC reporter, so it doesn't understand really understand coverage.

@paambaati paambaati added the question Further information is requested label Oct 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request question Further information is requested
Projects
None yet
Development

No branches or pull requests

2 participants