Skip to content

Add Sonar coverage artifact support - #125

Merged
sarasvoss merged 1 commit into
mainfrom
feat/sonar-coverage-artifact
Oct 5, 2026
Merged

sarasvoss merged 1 commit into
mainfrom
feat/sonar-coverage-artifact

Conversation

@sarasvoss

@sarasvoss sarasvoss commented Oct 5, 2026 •

Copy link
Copy Markdown
Contributor

Summary

  • add optional inputs for a same-run coverage artifact name and download path
  • download requested coverage before the Sonar scan using an immutable action pin
  • document the producer/consumer job contract and release it as workflow version 1.3.0

Testing

  • npx --yes npm@12.1.0 run ci
  • prettier --check .github/workflows/run_sonar_scan.yml .github/workflows/READMES/run_sonar_scan.md .github/workflows/CHANGELOGS/run_sonar_scan.md
  • actionlint -ignore 'label "ubuntu-26.04" is unknown' .github/workflows/run_sonar_scan.yml\n- git diff --check

Summary by CodeRabbit

  • New Features
    • Added optional support for downloading a coverage artifact before a SonarQube scan, with configurable artifact name and download location. If no artifact name is provided, the download is skipped.
  • Documentation
    • Updated usage guidance and examples for version 1.3.0, including artifact setup, expected report location, and behavior when a named artifact is missing.
    • Clarified that the workflow does not run tests or generate coverage.
  • Chores
    • Added a changelog entry for version 1.3.0.

@sarasvoss
sarasvoss requested a review from a team as a code owner October 5, 2026 18:38
@sarasvoss sarasvoss added the v:wf/run_sonar_scan/1.3.0 Release workflows/run_sonar_scan/1.3.0 label Oct 5, 2026
@github-actions

github-actions Bot commented Oct 5, 2026

Copy link
Copy Markdown

Tags

The following tags will be created on main after merge

🏷️ workflows/run_sonar_scan/1.3.0

@coderabbitai

coderabbitai Bot commented Oct 5, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Central YAML (base), Organization UI (inherited)
  • Review profile: CHILL
  • Plan: Enterprise
  • Run ID: 580f8d4b-b730-41c4-8a6e-2027aa13a338
📥 Commits

Reviewing files that changed from the base of the PR and between 9d0f664 and 9e770aa.

📒 Files selected for processing (3)
  • .github/workflows/CHANGELOGS/run_sonar_scan.md
  • .github/workflows/READMES/run_sonar_scan.md
  • .github/workflows/run_sonar_scan.yml

Included review availability: This review used your included allowance. Your plan provides up to 12 included reviews per hour; 11 remain after this review.


📝 Walkthrough

Walkthrough

The reusable SonarQube workflow adds optional inputs to download a coverage artifact before scanning. The README and changelog document the inputs, their use, and the artifact's expected location.

Changes

Coverage artifact download

Layer / File(s) Summary
Configure and download coverage artifacts
.github/workflows/run_sonar_scan.yml, .github/workflows/READMES/run_sonar_scan.md, .github/workflows/CHANGELOGS/run_sonar_scan.md
The workflow accepts an optional artifact name and destination path. When the name is set, it downloads the artifact before scanning. The README and changelog document the inputs and usage. The README example uses version 1.3.0.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Feature

Sequence Diagram(s)

sequenceDiagram
  participant TestJob
  participant ArtifactStore
  participant SonarQubeWorkflow
  participant SonarQubeScan
  TestJob->>ArtifactStore: Upload coverage artifact
  opt coverage-artifact-name is set
    SonarQubeWorkflow->>ArtifactStore: Download named artifact to configured path
  end
  SonarQubeWorkflow->>SonarQubeScan: Run scan
Loading

Suggested reviewers: alex-duhanov

Merge Risk: ⚪ Minimal · up to 9e770

Coverage remains optional, and the documented dependent job makes its report available before scanning. No actionable merge risk remains.

🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly identifies the main change: adding coverage artifact support for Sonar scans.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches 💡 1
🛠️ Fix failing CI checks 💡
  • Commit to this branch
  • Create a new PR
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Comment @coderabbitai help to get the list of available commands.

@sarasvoss
sarasvoss merged commit bd7204c into main Oct 5, 2026
5 of 6 checks passed
@sarasvoss
sarasvoss deleted the feat/sonar-coverage-artifact branch October 5, 2026 19:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

v:wf/run_sonar_scan/1.3.0 Release workflows/run_sonar_scan/1.3.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant