Skip to content

sonar: Update deprecated action #127

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

Merged
merged 2 commits into from
Apr 22, 2025
Merged

Conversation

echarrod
Copy link
Contributor

@echarrod echarrod commented Apr 17, 2025

This PR replaces the deprecated sonarsource/sonarcloud-github-action@master with the recommended SonarSource/sonarqube-scan-action@master as suggested in the CI warning message.

The warning message was:

::warning title=SonarScanner::This action is deprecated and will be removed in a future release. Please use the sonarqube-scan-action action instead. The sonarqube-scan-action is a drop-in replacement for this action.

This change follows the same pattern as used in luno-go, including the conditional check to only run the SonarQube scan when:

  • The pull request comes from the same repository (not a fork), or
  • The SONAR_TOKEN environment variable is available

Summary by CodeRabbit

  • Chores
    • Updated the workflow for uploading coverage reports to use a newer, more specific SonarQube scan action.
    • Added safeguards to ensure the upload step only runs under certain conditions, improving workflow security.

Copy link

coderabbitai bot commented Apr 17, 2025

Walkthrough

The GitHub Actions workflow responsible for uploading coverage reports to Sonar has been updated. The previous SonarCloud GitHub Action was replaced with a specific version of the SonarQube scan action. Additionally, a conditional clause was introduced to the upload step, ensuring it only executes when the pull request is from the same repository as the base or when a valid SONAR_TOKEN is present. No changes were made to any exported or public entities.

Changes

File(s) Change Summary
.github/workflows/sonar.yaml Replaced SonarCloud action with SonarQube scan action (v5.1.0) and added conditional execution logic

Poem

In the warren where code flows bright,
A new Sonar scan takes flight.
With careful checks and tokens tight,
Only trusted bunnies run at night.
Versioned steps hop into view—
Clean and safe, the scans are new!
🐇✨


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: 0

🧹 Nitpick comments (2)
.github/workflows/sonar.yaml (2)

31-31: Pin Action to a fixed version
Switching from a floating @master to SonarSource/sonarqube-scan-action@v5.1.0 is a great improvement. As a further enhancement, consider using a major tag (@v5) or a full SHA to lock in behavior and prevent unexpected changes on patch releases.

🧰 Tools
🪛 YAMLlint (1.35.1)

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

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


31-31: Append newline at end of file
YAML lint flagged a missing newline at EOF. Please add a blank line at the end of this file to satisfy POSIX conventions and eliminate the lint error.

🧰 Tools
🪛 YAMLlint (1.35.1)

[error] 31-31: 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 b5bf61a.

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

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

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

🔇 Additional comments (1)
.github/workflows/sonar.yaml (1)

30-30: Conditional gating for SonarQube scan
The if statement ensures the scan only runs on PRs from the same repository or when SONAR_TOKEN is provided. Verify that with push events (where github.event.pull_request is null), this step will be skipped—confirm this aligns with your intended CI policy.

@echarrod echarrod requested review from adamhicks and NeilLuno April 17, 2025 17:22
@echarrod echarrod merged commit 70e7a8f into main Apr 22, 2025
7 checks passed
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.

2 participants