Skip to content

Latest commit

 

History

History
49 lines (35 loc) · 2.02 KB

README.md

File metadata and controls

49 lines (35 loc) · 2.02 KB
Raw

Docs | Get Started | Discuss

The Code Health Platform

GitHub Action that enables you to upload your test coverage data to DeepSource easily. You must have the Test Coverage analyzer enabled on your repository for reporting to work.

If you're not using DeepSource yet, get started for free.

Usage

This Action assumes that the coverage file has already been generated after the tests have run. To integrate it in your workflow, define a step which refers to this Action in your workflow.yml file. We recommend that you use @master as the ref.

Ensure that you have added the DEEPSOURCE_DSN secret in your GitHub repository. It is available under Settings → Code Coverage of the repository page on DeepSource.

steps:
  - name: Report test coverage to DeepSource
    uses: deepsourcelabs/test-coverage-action@master
    with:
      key: python
      coverage-file: coverage.xml
      dsn: ${{ secrets.DEEPSOURCE_DSN }}

The possible inputs to this action are:

  • key (string, required): Programming language shortcode for which coverage is reported. e.g. python, go, javascript. See the docs for the current list of allowed values.
  • coverage-file (string, required): Path to the coverage data file. e. g. coverage.xml
  • dsn (string, required): DeepSource DSN of this repository.
  • fail-ci-on-error (boolean): Should the CI build fail if there is an error while uploading the report to DeepSource? Allowed values are: true, false. This is set to false by default.

License

This project is released under the MIT License.