swift-codecov-action

A very simple code coverage summary tool for Swift. This tool takes in the JSON output of Swift's code coverage analysis and produces an overall coverage percentage and per-file coverage percentages.

Under the hood, this action uses the https://github.com/mattpolzin/swift-test-codecov tool (written in Swift).

Run this as a GitHub action in the same workflow job as your project's tests are run.

Note that the flow below will only work if your project can be built & tested in a Linux environment because GitHub Actions cannot run Docker on Mac machines and this action runs in a Docker container.

For example,

jobs:
  codecov:
    container:
      image: swift:5.7
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v3
    - run: swift test --enable-test-discovery --enable-code-coverage
    - uses: mattpolzin/[email protected]
      with:
        MINIMUM_COVERAGE: 98
        INCLUDE_TESTS: 'true'

Note that you must execute your project's tests using swift test with the --enable-code-coverage argument to generate the file ingested by this action.

All boolean inputs below must be specified as strings (be sure to put them in quotes in your YAML file).

Inputs:

• PROJECT_NAME: The name of the target project. This must be specified if you would like local dependencies (specified by path in the project manifest) to be left out of coverage numbers. If specified, this must be exactly the same spelling as the root folder of the target project.
• CODECOV_JSON: The location of the JSON file produced by swift test --enable-code-coverage. By default .build/debug/codecov/*.json.
• MINIMUM_COVERAGE: By default, there is no minimum coverage. Set this to a percentage (floating point number between 0.0 and 100.0) to make the script fail if the minimum coverage is not met.
• PRINT_STDOUT: 'true' by default, but if 'false' then will not output the whole codecov table to stdout.
• SORT_ORDER: filename by default. Determines the sort order of the code coverage table. Possible values: filename, +cov, -cov.
• INCLUDE_DEPENDENCIES: 'false' by default, but if 'true' then coverage numbers will include project dependencies.
• INCLUDE_TESTS: 'false' by default, but if 'true' then coverage numbers will include the percentage of the test files themselves that was exercised.

Outputs:

• CODECOV: Overall code coverage percentage.
• MINIMUM_COVERAGE: Just passing through the MINIMUM_COVERAGE input.

Regardless of whether or not you have chosen to have the action print to stdout, the code coverage table will be dumped to the ./codecov.txt file.