feat: add coverage checks with min 80% threshold #70
Conversation
WalkthroughThe pull request introduces several changes to enhance the CI/CD pipeline for a Java project. A new GitHub Actions workflow file named Changes
Sequence Diagram(s)sequenceDiagram
participant Developer
participant GitHubActions as GitHub Actions
participant Gradle as Gradle
participant CoverageReport as Coverage Report
Developer->>GitHubActions: Push code or create PR
GitHubActions->>Gradle: Set up environment
GitHubActions->>Gradle: Run tests
Gradle->>CoverageReport: Generate coverage report
CoverageReport-->>GitHubActions: Return coverage data
GitHubActions->>Developer: Notify coverage status
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
ttypic
force-pushed
the
add-coverage-report
branch
from
eea472a to
22ce137
Compare
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Caution
Inline review comments failed to post. This is likely due to GitHub's limits when posting large numbers of comments.
Actionable comments posted: 2
🧹 Outside diff range and nitpick comments (6)
.github/workflows/check.yml (1)
21-23: Consider optimizing Gradle builds with caching.To improve CI performance, consider enabling Gradle build caching:
- name: Set up Gradle uses: gradle/gradle-build-action@v2 + with: + cache-read-only: ${{ github.ref != 'refs/heads/main' }} + gradle-home-cache-cleanup: trueAlso, consider moving Java configuration to environment variables for better maintainability:
+env: + JAVA_VERSION: '17' + JAVA_DISTRIBUTION: 'temurin' + jobs: check: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - name: Set up Java 17 uses: actions/setup-java@v4 with: - distribution: 'temurin' - java-version: '17' + distribution: ${{ env.JAVA_DISTRIBUTION }} + java-version: ${{ env.JAVA_VERSION }}.github/workflows/coverage.yml (3)
3-8: Consider adding branch filters for pull_request triggerThe workflow currently runs on all pull requests without branch filtering. Consider adding branch filters to optimize CI resources by only running on relevant branches.
pull_request: + branches: + - main
35-41: Improve coverage threshold check implementationSeveral improvements can be made to the coverage check:
- Make the threshold configurable via environment variable
- Use more portable arithmetic comparison
- Add more detailed failure message
- name: Fail if coverage is too low run: | - MIN_COVERAGE=0.80 - if (( $(echo "$COVERAGE < $MIN_COVERAGE" | bc -l) )); then - echo "Coverage ($COVERAGE) is below the minimum threshold ($MIN_COVERAGE)." + MIN_COVERAGE=${MIN_COVERAGE:-0.80} + COVERAGE_PERCENT=$(awk "BEGIN {print $COVERAGE * 100}") + MIN_COVERAGE_PERCENT=$(awk "BEGIN {print $MIN_COVERAGE * 100}") + if awk "BEGIN {exit !($COVERAGE < $MIN_COVERAGE)}"; then + echo "❌ Coverage: $COVERAGE_PERCENT% (Required: $MIN_COVERAGE_PERCENT%)" + echo "Please add more tests to increase coverage." exit 1 fi + echo "✅ Coverage: $COVERAGE_PERCENT% (Required: $MIN_COVERAGE_PERCENT%)"
26-28: Consider enhancing coverage reportingThe current workflow could benefit from additional features:
- Upload coverage report as an artifact
- Integrate with a coverage visualization tool (e.g., Codecov)
Here's an example of how to add these enhancements:
- name: Run tests and generate coverage report run: ./gradlew koverXmlReport + - name: Upload coverage report + uses: actions/upload-artifact@v3 + with: + name: coverage-report + path: build/reports/kover/report.xml + + - name: Upload to Codecov + uses: codecov/codecov-action@v3 + with: + file: build/reports/kover/report.xmlchat-android/build.gradle.kts (2)
7-7: LGTM, but coverage configuration is missing.While adding the Kover plugin is correct, the configuration needed to enforce the 80% coverage threshold is missing.
Add the following configuration block after the plugins section:
koverReport { defaults { xml { onCheck = true } } filters { excludes { // Add any classes that should be excluded from coverage classes("*BuildConfig") } } verify { rule { isEnabled = true bound { minValue = 80 valueType = kotlinx.kover.api.VerificationValueType.COVERED_LINES_PERCENTAGE } } } }Also, consider using a stable version of Kover instead of 0.9.0-RC for production use. The latest stable version can be found in the Kover releases.
Line range hint
63-67: Consider adding coverage verification to the test task.To ensure coverage checks are run as part of the testing process, you might want to link coverage verification to the test task.
Add this configuration to your test task:
tasks.withType<Test>().configureEach { testLogging { exceptionFormat = TestExceptionFormat.FULL } finalizedBy(tasks.named("koverVerify")) }
🛑 Comments failed to post (2)
.github/workflows/coverage.yml (1)
29-34: 🛠️ Refactor suggestion
Make coverage extraction more robust
The current grep-based XML parsing is fragile and might break with different XML formats. Consider using a proper XML parsing tool.
- - name: Extract coverage from XML + - name: Extract coverage from XML run: | - COVERAGE=$(grep -oP 'line-rate="([0-9.]+)"' build/reports/kover/report.xml | head -1 | grep -oP '[0-9.]+') + COVERAGE=$(xmlstarlet sel -t -v "//report/@line-rate" build/reports/kover/report.xml) echo "Coverage: ${COVERAGE}" - echo "coverage=${COVERAGE}" >> $GITHUB_ENV + echo "coverage=${COVERAGE}" >> "$GITHUB_ENV"Committable suggestion skipped: line range outside the PR's diff.
🧰 Tools
🪛 actionlint (1.7.4)
30-30: shellcheck reported issue in this script: SC2086:info:3:32: Double quote to prevent globbing and word splitting
(shellcheck)
gradle/libs.versions.toml (1)
69-69: 💡 Codebase verification
Consider using Kover 0.8.3 instead of 0.9.0-RC
The latest stable version 0.8.3 is recommended for production use. Version 0.9.0-RC is a release candidate that introduces new features but may have stability issues. Version 0.8.3 is production-ready and includes support for Android projects.
🔗 Analysis chain
Consider using a stable version of Kover.
The current RC version (0.9.0-RC) might have stability issues. Consider using the latest stable version for production use.
Let's verify the latest stable version and its compatibility with Kotlin 2.0.10:
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Check latest Kover versions and compatibility # Check Maven Central for latest versions curl -s "https://search.maven.org/solrsearch/select?q=g:org.jetbrains.kotlinx.kover+AND+a:kotlinx-kover-gradle-plugin&rows=5&wt=json" | jq -r '.response.docs[].v' # Check GitHub releases for compatibility notes gh api repos/Kotlin/kotlinx-kover/releases --jq '.[0:3] | .[] | {tag_name, body}'Length of output: 3302
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Outside diff range and nitpick comments (1)
.github/workflows/coverage.yml (1)
9-24: Consider adding caching for better performanceAdding caching for Gradle dependencies can significantly improve workflow execution time.
Apply this diff to enable caching:
- name: Set up Gradle uses: gradle/gradle-build-action@v2 + with: + cache-read-only: ${{ github.ref != 'refs/heads/main' }}
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (4)
.github/workflows/check.yml(1 hunks).github/workflows/coverage.yml(1 hunks)chat-android/build.gradle.kts(1 hunks)gradle/libs.versions.toml(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (3)
- .github/workflows/check.yml
- chat-android/build.gradle.kts
- gradle/libs.versions.toml
🧰 Additional context used
🪛 actionlint (1.7.4)
.github/workflows/coverage.yml
29-29: shellcheck reported issue in this script: SC2086:info:3:32: Double quote to prevent globbing and word splitting
(shellcheck)
🔇 Additional comments (2)
.github/workflows/coverage.yml (2)
1-8: LGTM! Workflow configuration is well structured
The workflow triggers and branch configuration are appropriate for maintaining code coverage standards.
25-27: Verify Kover configuration in Gradle
Ensure that the Kover plugin is properly configured in the Gradle build files.
✅ Verification successful
Kover plugin is properly configured
The Kover plugin is correctly configured in the chat-android/build.gradle.kts file through the plugins block:
plugins {
alias(libs.plugins.kover)
}This confirms that the koverXmlReport task used in the GitHub Actions workflow will work as expected.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Check if Kover plugin is configured in Gradle files
echo "Checking Kover configuration in Gradle files..."
rg -l "id\(\"org\.jetbrains\.kotlinx\.kover\"\)" || \
rg -l "kotlin\.code\.coverage"
Length of output: 186
Script:
#!/bin/bash
# Let's check build.gradle files for Kover configuration using different patterns
echo "Checking build.gradle and build.gradle.kts files for Kover..."
fd -e gradle -e gradle.kts | xargs cat
# Also check settings.gradle files for plugin management
echo -e "\nChecking settings.gradle files..."
fd settings.gradle settings.gradle.kts | xargs cat
Length of output: 6159
ttypic
force-pushed
the
add-coverage-report
branch
from
22ce137 to
f850913
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Outside diff range and nitpick comments (2)
.github/workflows/coverage.yml (2)
22-24: Enable Gradle caching for faster buildsWhile the Gradle setup is correct, enabling caching can significantly improve workflow execution time.
Add caching configuration:
- name: Set up Gradle uses: gradle/gradle-build-action@v2 + with: + cache-read-only: ${{ github.ref != 'refs/heads/main' }}
34-40: Add coverage value logging for better visibilityWhile the failure condition is properly handled, adding more detailed logging would improve debugging.
Enhance the logging:
- name: Fail if coverage is too low run: | MIN_COVERAGE=0.80 + echo "Current coverage: ${COVERAGE}%" + echo "Required minimum: ${MIN_COVERAGE}%" if awk "BEGIN {exit !($COVERAGE < $MIN_COVERAGE)}"; then echo "Coverage ($COVERAGE) is below the minimum threshold ($MIN_COVERAGE)." exit 1 + else + echo "✅ Coverage check passed" fi
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (4)
.github/workflows/check.yml(1 hunks).github/workflows/coverage.yml(1 hunks)chat-android/build.gradle.kts(1 hunks)gradle/libs.versions.toml(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (3)
- .github/workflows/check.yml
- chat-android/build.gradle.kts
- gradle/libs.versions.toml
🧰 Additional context used
🪛 actionlint (1.7.4)
.github/workflows/coverage.yml
29-29: shellcheck reported issue in this script: SC2086:info:3:32: Double quote to prevent globbing and word splitting
(shellcheck)
🔇 Additional comments (2)
.github/workflows/coverage.yml (2)
9-11: 🛠️ Refactor suggestion
Define explicit permissions for security
It's recommended to define explicit permissions for the job to follow the principle of least privilege.
Add the following permissions configuration:
jobs:
coverage:
runs-on: ubuntu-latest
+ permissions:
+ contents: read
+ checks: write28-32:
Improve robustness of coverage extraction
The current coverage extraction method has potential issues with XML parsing and variable handling.
Consider using a more robust approach as suggested in the previous review.
🧰 Tools
🪛 actionlint (1.7.4)
29-29: shellcheck reported issue in this script: SC2086:info:3:32: Double quote to prevent globbing and word splitting
(shellcheck)
ttypic
force-pushed
the
add-coverage-report
branch
from
f850913 to
8cb1eda
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Outside diff range and nitpick comments (1)
.github/workflows/coverage.yml (1)
41-47: Externalize coverage threshold configurationThe minimum coverage threshold is hardcoded in the workflow. Consider making it configurable through repository variables or environment files.
Example implementation:
- name: Fail if coverage is too low run: | - MIN_COVERAGE=0.80 + MIN_COVERAGE="${MIN_COVERAGE:-0.80}" # Default to 80% if not set if awk "BEGIN {exit !($COVERAGE < $MIN_COVERAGE)}"; then echo "Coverage ($COVERAGE) is below the minimum threshold ($MIN_COVERAGE)." exit 1 fi
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (4)
.github/workflows/check.yml(1 hunks).github/workflows/coverage.yml(1 hunks)chat-android/build.gradle.kts(1 hunks)gradle/libs.versions.toml(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (3)
- .github/workflows/check.yml
- chat-android/build.gradle.kts
- gradle/libs.versions.toml
🧰 Additional context used
🪛 actionlint (1.7.4)
.github/workflows/coverage.yml
29-29: shellcheck reported issue in this script: SC2086:info:10:37: Double quote to prevent globbing and word splitting
(shellcheck)
🔇 Additional comments (3)
.github/workflows/coverage.yml (3)
1-8: LGTM! Workflow triggers are well configured.
The workflow name is descriptive and the triggers are appropriate for coverage monitoring on both PRs and main branch.
9-11: 🛠️ Refactor suggestion
Define explicit permissions for security
It's recommended to define explicit permissions for the job to follow the principle of least privilege.
Add the following permissions configuration:
jobs:
coverage:
runs-on: ubuntu-latest
+ permissions:
+ contents: read
+ checks: write25-26:
Add error handling for Gradle command
The Gradle command execution lacks proper error handling and output verification.
.github/workflows/coverage.yml
Outdated
| - name: Extract coverage from XML | ||
| run: | | ||
| # Extract missed and covered lines from the XML | ||
| MISSED=$(xmllint --xpath 'string(//report/counter[@type="LINE"]/@missed)' chat-android/build/reports/kover/report.xml) | ||
| COVERED=$(xmllint --xpath 'string(//report/counter[@type="LINE"]/@covered)' chat-android/build/reports/kover/report.xml) | ||
|
|
||
| # Calculate line coverage percentage | ||
| TOTAL=$((MISSED + COVERED)) | ||
| LINE_COVERAGE=$(echo "scale=2; $COVERED / $TOTAL * 100" | bc) | ||
|
|
||
| echo "Line Coverage: ${LINE_COVERAGE}%" | ||
| echo "coverage=${LINE_COVERAGE}" >> $GITHUB_ENV | ||
|
|
There was a problem hiding this comment.
Improve robustness of coverage calculation
The current implementation has several potential issues:
- Missing error handling for xmllint commands
- Unquoted variables in arithmetic operations
- No validation of extracted values
Apply this diff to improve robustness:
- name: Extract coverage from XML
run: |
+ REPORT_PATH="chat-android/build/reports/kover/report.xml"
+ if [ ! -f "$REPORT_PATH" ]; then
+ echo "Coverage report not found at $REPORT_PATH"
+ exit 1
+ fi
+
# Extract missed and covered lines from the XML
- MISSED=$(xmllint --xpath 'string(//report/counter[@type="LINE"]/@missed)' chat-android/build/reports/kover/report.xml)
- COVERED=$(xmllint --xpath 'string(//report/counter[@type="LINE"]/@covered)' chat-android/build/reports/kover/report.xml)
+ MISSED=$(xmllint --xpath 'string(//report/counter[@type="LINE"]/@missed)' "$REPORT_PATH") || exit 1
+ COVERED=$(xmllint --xpath 'string(//report/counter[@type="LINE"]/@covered)' "$REPORT_PATH") || exit 1
+
+ # Validate extracted values
+ if ! [[ "$MISSED" =~ ^[0-9]+$ ]] || ! [[ "$COVERED" =~ ^[0-9]+$ ]]; then
+ echo "Failed to extract valid coverage values"
+ exit 1
+ fi
# Calculate line coverage percentage
- TOTAL=$((MISSED + COVERED))
- LINE_COVERAGE=$(echo "scale=2; $COVERED / $TOTAL * 100" | bc)
+ TOTAL=$((MISSED + COVERED))
+ if [ "$TOTAL" -eq 0 ]; then
+ echo "No lines to calculate coverage"
+ exit 1
+ fi
+ LINE_COVERAGE=$(echo "scale=2; $COVERED / $TOTAL * 100" | bc)
echo "Line Coverage: ${LINE_COVERAGE}%"
- echo "coverage=${LINE_COVERAGE}" >> $GITHUB_ENV
+ echo "coverage=${LINE_COVERAGE}" >> "$GITHUB_ENV"📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - name: Extract coverage from XML | |
| run: | | |
| # Extract missed and covered lines from the XML | |
| MISSED=$(xmllint --xpath 'string(//report/counter[@type="LINE"]/@missed)' chat-android/build/reports/kover/report.xml) | |
| COVERED=$(xmllint --xpath 'string(//report/counter[@type="LINE"]/@covered)' chat-android/build/reports/kover/report.xml) | |
| # Calculate line coverage percentage | |
| TOTAL=$((MISSED + COVERED)) | |
| LINE_COVERAGE=$(echo "scale=2; $COVERED / $TOTAL * 100" | bc) | |
| echo "Line Coverage: ${LINE_COVERAGE}%" | |
| echo "coverage=${LINE_COVERAGE}" >> $GITHUB_ENV | |
| - name: Extract coverage from XML | |
| run: | | |
| REPORT_PATH="chat-android/build/reports/kover/report.xml" | |
| if [ ! -f "$REPORT_PATH" ]; then | |
| echo "Coverage report not found at $REPORT_PATH" | |
| exit 1 | |
| fi | |
| # Extract missed and covered lines from the XML | |
| MISSED=$(xmllint --xpath 'string(//report/counter[@type="LINE"]/@missed)' "$REPORT_PATH") || exit 1 | |
| COVERED=$(xmllint --xpath 'string(//report/counter[@type="LINE"]/@covered)' "$REPORT_PATH") || exit 1 | |
| # Validate extracted values | |
| if ! [[ "$MISSED" =~ ^[0-9]+$ ]] || ! [[ "$COVERED" =~ ^[0-9]+$ ]]; then | |
| echo "Failed to extract valid coverage values" | |
| exit 1 | |
| fi | |
| # Calculate line coverage percentage | |
| TOTAL=$((MISSED + COVERED)) | |
| if [ "$TOTAL" -eq 0 ]; then | |
| echo "No lines to calculate coverage" | |
| exit 1 | |
| fi | |
| LINE_COVERAGE=$(echo "scale=2; $COVERED / $TOTAL * 100" | bc) | |
| echo "Line Coverage: ${LINE_COVERAGE}%" | |
| echo "coverage=${LINE_COVERAGE}" >> "$GITHUB_ENV" |
🧰 Tools
🪛 actionlint (1.7.4)
29-29: shellcheck reported issue in this script: SC2086:info:10:37: Double quote to prevent globbing and word splitting
(shellcheck)
ttypic
force-pushed
the
add-coverage-report
branch
from
8cb1eda to
f2882f3
Compare
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (2)
.github/workflows/coverage.yml (2)
28-30: Improve package installation robustnessAdd error handling and quiet flags to apt commands.
- run: sudo apt-get update && sudo apt-get install -y libxml2-utils + run: | + if ! sudo apt-get update -q; then + echo "Failed to update package list" + exit 1 + fi + if ! sudo apt-get install -y -q libxml2-utils; then + echo "Failed to install libxml2-utils" + exit 1 + fi
1-50: Consider enhancing coverage reporting capabilitiesWhile the current implementation meets the basic requirement of enforcing 80% coverage, consider these enhancements:
- Upload coverage reports as artifacts for historical tracking
- Add coverage trend analysis
- Generate detailed HTML reports for better visualization
- Add per-package coverage metrics
Example step for uploading artifacts:
- name: Upload coverage report uses: actions/upload-artifact@v3 with: name: coverage-report path: chat-android/build/reports/kover/ retention-days: 14🧰 Tools
🪛 actionlint (1.7.4)
32-32: shellcheck reported issue in this script: SC2086:info:10:37: Double quote to prevent globbing and word splitting
(shellcheck)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (4)
.github/workflows/check.yml(1 hunks).github/workflows/coverage.yml(1 hunks)chat-android/build.gradle.kts(1 hunks)gradle/libs.versions.toml(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (3)
- .github/workflows/check.yml
- chat-android/build.gradle.kts
- gradle/libs.versions.toml
🧰 Additional context used
🪛 actionlint (1.7.4)
.github/workflows/coverage.yml
32-32: shellcheck reported issue in this script: SC2086:info:10:37: Double quote to prevent globbing and word splitting
(shellcheck)
🔇 Additional comments (5)
.github/workflows/coverage.yml (5)
9-11: Define explicit permissions for security
It's recommended to define explicit permissions for the job to follow the principle of least privilege.
12-24: Environment setup looks good!
The setup uses specific versions of actions and appropriate configurations for Java and Gradle.
25-26: Add error handling for Gradle command
The Gradle command execution lacks proper error handling and output verification.
31-43: Improve robustness of coverage calculation
The current implementation has several potential issues with error handling and variable quoting.
🧰 Tools
🪛 actionlint (1.7.4)
32-32: shellcheck reported issue in this script: SC2086:info:10:37: Double quote to prevent globbing and word splitting
(shellcheck)
44-50: Coverage threshold check looks good!
The implementation correctly enforces the 80% coverage threshold with clear error messaging.
ttypic
force-pushed
the
add-coverage-report
branch
from
f2882f3 to
b384b18
Compare
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (3)
.github/workflows/coverage.yml (3)
11-11: Consider pinning the Ubuntu versionUsing
ubuntu-latestmight lead to reproducibility issues when GitHub updates the runner image. Consider pinning to a specific version likeubuntu-22.04.- runs-on: ubuntu-latest + runs-on: ubuntu-22.04
46-46: Make coverage threshold configurableConsider making the coverage threshold configurable through workflow inputs or environment variables for flexibility.
- MIN_COVERAGE=80.0 + MIN_COVERAGE=${MIN_COVERAGE_THRESHOLD:-80.0}This allows overriding the threshold:
env: MIN_COVERAGE_THRESHOLD: 85.0
44-51: Consider adding status checksThe workflow could benefit from creating status checks to display coverage results directly on PRs. Consider using actions like
create-status-checkorcreate-pr-commentto improve visibility.Example addition:
- name: Create Status Check if: github.event_name == 'pull_request' uses: actions/github-script@v7 with: script: | const coverage = process.env.coverage await github.rest.checks.create({ owner: context.repo.owner, repo: context.repo.repo, name: 'Coverage', head_sha: context.sha, status: 'completed', conclusion: coverage >= 80 ? 'success' : 'failure', output: { title: 'Coverage Report', summary: `Coverage: ${coverage}%` } })
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (4)
.github/workflows/check.yml(1 hunks).github/workflows/coverage.yml(1 hunks)chat-android/build.gradle.kts(1 hunks)gradle/libs.versions.toml(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (3)
- .github/workflows/check.yml
- chat-android/build.gradle.kts
- gradle/libs.versions.toml
🧰 Additional context used
🪛 actionlint (1.7.4)
.github/workflows/coverage.yml
32-32: shellcheck reported issue in this script: SC2086:info:10:37: Double quote to prevent globbing and word splitting
(shellcheck)
🔇 Additional comments (4)
.github/workflows/coverage.yml (4)
9-11: Define explicit permissions for security
The workflow should define explicit permissions following the principle of least privilege.
25-26: Add error handling for Gradle command
The Gradle command execution lacks proper error handling and output verification.
31-43: Improve robustness of coverage calculation
The current implementation needs improvements in error handling, variable quoting, and value validation.
🧰 Tools
🪛 actionlint (1.7.4)
32-32: shellcheck reported issue in this script: SC2086:info:10:37: Double quote to prevent globbing and word splitting
(shellcheck)
48-51: Improve coverage threshold validation
The current validation using bc might fail in some environments.
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Outside diff range and nitpick comments (2)
.github/workflows/coverage.yml (2)
3-8: Optimize workflow triggersConsider refining the triggers to:
- Specify explicit PR event types
- Add path filters to run only when relevant files change
on: pull_request: + types: [opened, synchronize, reopened] + paths: + - '**/*.kt' + - '**/*.kts' + - '.github/workflows/coverage.yml' push: branches: - main + paths: + - '**/*.kt' + - '**/*.kts' + - '.github/workflows/coverage.yml'
30-30: Pin third-party action version and validate configuration
- The
mi-kas/kover-reportaction should use a commit hash for better security- Consider adding coverage trend tracking
- uses: mi-kas/kover-report@v1 + uses: mi-kas/kover-report@a5b2c3d4 # Replace with actual commit hash with: title: Code Coverage update-comment: true min-coverage-overall: 80 coverage-counter-type: LINE + coverage-badge: true + coverage-badge-filename: coverage-badge.svgAlso applies to: 35-37
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
.github/workflows/coverage.yml(1 hunks)
🔇 Additional comments (2)
.github/workflows/coverage.yml (2)
9-11: 🛠️ Refactor suggestion
Add job-level configurations for security and efficiency
The job configuration needs:
- Explicit permissions (for security)
- Concurrency control (for efficiency)
jobs:
coverage:
runs-on: ubuntu-latest
+ permissions:
+ contents: read
+ checks: write
+ pull-requests: write
+ concurrency:
+ group: ${{ github.workflow }}-${{ github.ref }}
+ cancel-in-progress: trueThe permissions configuration was previously suggested.
25-26: 🛠️ Refactor suggestion
Add error handling for Gradle command
The Gradle command execution needs proper error handling.
Error handling improvement was previously suggested.
| id: kover | ||
| uses: mi-kas/kover-report@v1 | ||
| with: | ||
| path: | | ||
| ${{ github.workspace }}/chat-android/build/reports/kover/report.xml | ||
| title: Code Coverage |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Improve path handling in coverage report step
The current path handling could be more robust:
- Use path variables for reusability
- Add path existence check
- name: Add coverage report to PR
id: kover
uses: mi-kas/kover-report@v1
+ env:
+ REPORT_PATH: chat-android/build/reports/kover/report.xml
with:
path: |
- ${{ github.workspace }}/chat-android/build/reports/kover/report.xml
+ ${{ github.workspace }}/${{ env.REPORT_PATH }}
+ if: |
+ hashFiles(format('{0}/{1}', github.workspace, env.REPORT_PATH)) != ''Committable suggestion skipped: line range outside the PR's diff.
Code Coverage
|
Added coverage report for SDK
Summary by CodeRabbit
New Features
Improvements
Bug Fixes