Structure

CoverageAction

Reads and summarizes native coverage artifacts produced by a prior test run.

struct CoverageAction

Overview

ShipItSwifty does not generate coverage data itself — it wraps and normalises the artifacts that your platform toolchain already produces:

iOS: .xcresult bundles created by xcodebuild test -enableCodeCoverage YES
Android: JaCoCo XML reports generated by Gradle’s jacocoTestReport task

Usage

// iOS — infer xcresult from config
let result = try await CoverageAction().run(
    with: .init(firstPartyOnly: true, format: .text),
    context: context
)
print("Overall: \(result.overallLineCoverage)%")

// Android — explicit report path
let result = try await CoverageAction().run(
    with: .init(reportPath: "./app/build/reports/jacoco/test/jacocoTestReport.xml"),
    context: androidContext
)
for module in result.modules { print("\(module.name): \(module.lineCoverage)%") }

Topics

Configuration

struct Options
Configuration options for the coverage action.

Results

struct Result
Summary of coverage across all selected targets/modules.
struct CoverageTarget
Coverage entry for a single target (iOS) or module/package (Android).
struct CoverageFile
Coverage entry for a single source file.

Initializers

init()

Instance Methods

func run(with: CoverageAction.Options, context: ActionContext) async throws -> CoverageAction.Result
Execute the action with the given options.

Type Properties

static let description: String
Long-form description for --help output and documentation.
static let name: String
Human-readable identifier, e.g. "build", "upload".