Skip to content

sonar: Update deprecated action #40

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 2 commits into
base: main
Choose a base branch
from

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 Sonar with improved action and execution conditions.

Copy link

coderabbitai bot commented Apr 17, 2025

Walkthrough

The GitHub Actions workflow for Sonar coverage reporting has been updated. The action responsible for uploading coverage reports was switched from sonarsource/sonarcloud-github-action@master to SonarSource/[email protected]. Additionally, a conditional statement was introduced to ensure that the upload step only runs if the pull request is from the same repository or if the SONAR_TOKEN environment variable is set. The SONAR_TOKEN continues to be sourced from repository secrets.

Changes

File(s) Change Summary
.github/workflows/sonar.yml Updated Sonar upload action to SonarSource/[email protected] and added conditional execution to run only for PRs from the same repo or when SONAR_TOKEN is set.

Poem

In the warren of workflows, a change hops by,
A new Sonar action, reaching for the sky!
With a clever condition, it checks before run,
Only sending reports when the setup is done.
Secrets stay safe, as the tokens align—
This bunny approves, the pipeline’s just fine!
🐇✨

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)
  • We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.

🪧 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 (1)
.github/workflows/sonar.yml (1)

46-46: Replace deprecated action and pin version
Switching to SonarSource/sonarqube-scan-action@master addresses the deprecation warning. For greater stability, consider pinning to a specific tag or commit SHA instead of @master.
Additionally, the file currently lacks a trailing newline—adding one will satisfy YAML lint requirements.

🧰 Tools
🪛 YAMLlint (1.35.1)

[error] 46-46: 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 d2735e1 and 3cb2813.

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

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

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

🔇 Additional comments (2)
.github/workflows/sonar.yml (2)

44-44: Load SONAR_TOKEN from repository secrets
This step correctly injects the SONAR_TOKEN secret into the job’s environment, ensuring the SonarQube scanner can authenticate.


45-45: Ensure correct conditional for scan execution
The if clause limits execution to PRs originating from the same repo or runs when SONAR_TOKEN is set (e.g., on main‑branch pushes). Please verify that this expression behaves as intended across both pull_request and push events to avoid inadvertently skipping scans.

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 (1)
.github/workflows/sonar.yml (1)

46-46: Add a trailing newline
YAML parsers and linters (e.g., yamllint) expect a newline at EOF to avoid warnings.

🧰 Tools
🪛 YAMLlint (1.35.1)

[error] 46-46: 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 3cb2813 and a0b607e.

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

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

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

🔇 Additional comments (3)
.github/workflows/sonar.yml (3)

44-44: Secret mapping looks correct
Loading SONAR_TOKEN from secrets.SONAR_TOKEN into the step’s environment ensures the scan can authenticate.


45-45: Verify the if conditional for all event types
On a push event, github.event.pull_request will be null, so github.event.pull_request.head.repo.full_name resolves to an empty string. Ensure this expression behaves as expected (you might need to provide a fallback or wrap the entire expression in ${{ }} for clarity).


46-46: Confirm the chosen action version
You’ve pinned to SonarSource/[email protected]. Double‑check whether you prefer a fixed version (recommended for reproducibility) or the @master branch as originally noted in the PR description.

🧰 Tools
🪛 YAMLlint (1.35.1)

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

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

@echarrod echarrod requested a review from NeilLuno April 17, 2025 17:23
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