stanfordbdhg / swiftpackagetemplate Goto Github PK

Description

Xcode previews are currently reported as uncovered code in the code coverage report.

Reproduction

Adding a SwiftUI preview (even with the DEBUG #if statement) is still reported in the code coverage, e.g.:

#if DEBUG
struct Example_Previews: PreviewProvider {
    static var previews: some View {
        Example()
    }
}
#endif

The behaviour can also be reproduced in different Spezi Swift Packages, including the diff code coverage in StanfordSpezi/SpeziAccount#6.

Expected behavior

The preview provides (or even the new #Preview macro) should be excluded from the code coverage report based on the TEST active compilation condition. The TEST active compilation condition should be propagated in the compilation for tests, and the DEBUG flag should ensure that the preview provider is built when showing a view in the Xcode preview.

Code of Conduct

• I agree to follow this project's Code of Conduct and Contributing Guidelines

Problem

We want to start supporting a Kotlin-based version of different packages to support our Android-based projects better.

To get started with the Kotlin-based version of libraries, we need to set up a build and test pipeline with Gradel for the Template Repository.

Solution

The first setup should contain a basic structure including:

• Automated build and tests using a GitHub Action
• Code Coverage reporting using CodeCov
• A code linter with a strict and comprehensive rule set
• Automatic deployment of a gradle package to GitHub on a release, e.g., using https://docs.github.com/en/actions/publishing-packages/publishing-java-packages-with-gradle

Additional context

No response

Code of Conduct

• I agree to follow this project's Code of Conduct and Contributing Guidelines