Skip to content

Files

Latest commit

 

History

History
33 lines (22 loc) · 1.94 KB

README.md

File metadata and controls

33 lines (22 loc) · 1.94 KB

DeepSource Test Coverage Action

DeepSource

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. Please refer to the .deepsource.toml configuration reference for details.

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 @masteras the ref.

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. Allowed values are: python, go.
  • coverage-file (string, required): Path to the coverage data file. e. g. coverage.xml
  • dsn (string, required): DeepSource DSN of this repository. It is available under Settings → Reporting tab of the repository page on DeepSource.
  • 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.