Skip to content

Add Sonar workflow configuration #126

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

echarrod
Copy link
Contributor

@echarrod echarrod commented Apr 16, 2025

Add Sonar workflow configuration with Go 1.24.

Created by GitHub Copilot.

Summary by CodeRabbit

  • Chores
    • Introduced automated SonarCloud code coverage reporting for pushes and pull requests to the main branch.

Copy link

coderabbitai bot commented Apr 16, 2025

Walkthrough

A new GitHub Actions workflow configuration file, sonar.yml, has been added under the .github/workflows directory. This workflow, named "Sonar Report," is set to run on pushes and pull requests to the "main" branch. It checks out the code, sets up Go 1.24, runs Go tests with coverage output in JSON format, and uploads the coverage report to SonarCloud using a Sonar token for authentication, subject to certain conditions.

Changes

File(s) Change Summary
.github/workflows/sonar.yml Added a new GitHub Actions workflow for running Go tests, generating coverage, and uploading to SonarCloud.

Poem

In the warren, code now flows,
With Sonar reports, the coverage grows.
Each push and pull, a test is run,
Go code checked beneath the sun.
With tokens safe and actions bright,
Our code hops forward, pure and right! 🐇✨


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (1)
.github/workflows/sonar.yml (1)

28-28: Add a newline at end of file.

For style compliance and to avoid linter warnings, add a newline at the end of the file.

🧰 Tools
🪛 YAMLlint (1.35.1)

[error] 28-28: no new line character at the end of file

(new-line-at-end-of-file)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between df3e65f and b9fc704.

📒 Files selected for processing (1)
  • .github/workflows/sonar.yml (1 hunks)
🧰 Additional context used
🪛 YAMLlint (1.35.1)
.github/workflows/sonar.yml

[error] 28-28: no new line character at the end of file

(new-line-at-end-of-file)

go-version: '1.24'

- name: Generate Sonar Report
run: go test -coverpkg=./... -coverprofile=coverage.out -json ./... > sonar-report.json
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Potential coverage report format mismatch for SonarCloud.

The command:

run: go test -coverpkg=./... -coverprofile=coverage.out -json ./... > sonar-report.json

outputs test results in JSON format to sonar-report.json, but SonarCloud typically expects the Go coverage file (coverage.out) in its native format, not JSON. You may want to upload coverage.out instead, or check SonarCloud documentation to ensure the correct file is being used.

Consider splitting the commands:

run: |
  go test -coverpkg=./... -coverprofile=coverage.out ./...

and then upload coverage.out to SonarCloud.

Let me know if you want a corrected workflow snippet.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant