Skip to content

chore: update status badges#163

Merged
nanotaboada merged 1 commit intomasterfrom
feature/readme-status-badges
Mar 24, 2025
Merged

chore: update status badges#163
nanotaboada merged 1 commit intomasterfrom
feature/readme-status-badges

Conversation

@nanotaboada
Copy link
Copy Markdown
Owner

@nanotaboada nanotaboada commented Mar 24, 2025

This change is Reviewable

Summary by CodeRabbit

  • Documentation
    • Updated project status badges in the documentation.
    • Introduced a new badge to display bug metrics.
    • Replaced an existing maintainability badge with an updated quality metric.
    • Added an additional code quality badge to provide enhanced insights.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 24, 2025

Walkthrough

The pull request updates the status badges in the project's README. The Code Climate maintainability badge is replaced with a Qlty.sh badge, a new SonarCloud Bugs badge is added, and a Codebeat badge is introduced. No public or exported entity declarations were altered.

Changes

File Summary
README.md Replaced the Code Climate maintainability badge with a Qlty.sh badge; added SonarCloud Bugs and Codebeat badges to the status section.

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 plan to trigger planning for file edits and PR creation.
  • @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.

@qlty-cloud-legacy
Copy link
Copy Markdown

Code Climate has analyzed commit 19e4a6f and detected 1 issue on this pull request.

Here's the issue category breakdown:

Category Count
Style 1

View more on Code Climate.

## Status

[![Java CI with Maven](https://github.com/nanotaboada/java.samples.spring.boot/actions/workflows/maven.yml/badge.svg)](https://github.com/nanotaboada/java.samples.spring.boot/actions/workflows/maven.yml) [![CodeFactor](https://www.codefactor.io/repository/github/nanotaboada/java.samples.spring.boot/badge)](https://www.codefactor.io/repository/github/nanotaboada/java.samples.spring.boot) [![Maintainability](https://api.codeclimate.com/v1/badges/2b6a5b7ec87a44d622d9/maintainability)](https://codeclimate.com/github/nanotaboada/java.samples.spring.boot/maintainability) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/ea6918db332642089ef420822267931b)](https://app.codacy.com/gh/nanotaboada/java.samples.spring.boot/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade) [![codecov](https://codecov.io/gh/nanotaboada/java.samples.spring.boot/branch/master/graph/badge.svg?token=D3FMNG0WOI)](https://codecov.io/gh/nanotaboada/java.samples.spring.boot) [![Known Vulnerabilities](https://snyk.io/test/github/nanotaboada/java.samples.spring.boot/badge.svg)](https://snyk.io/test/github/nanotaboada/java.samples.spring.boot)
[![Java CI with Maven](https://github.com/nanotaboada/java.samples.spring.boot/actions/workflows/maven.yml/badge.svg)](https://github.com/nanotaboada/java.samples.spring.boot/actions/workflows/maven.yml) [![Bugs](https://sonarcloud.io/api/project_badges/measure?project=nanotaboada_java.samples.spring.boot&metric=bugs)](https://sonarcloud.io/summary/new_code?id=nanotaboada_java.samples.spring.boot) [![CodeFactor](https://www.codefactor.io/repository/github/nanotaboada/java.samples.spring.boot/badge)](https://www.codefactor.io/repository/github/nanotaboada/java.samples.spring.boot) [![codebeat badge](https://codebeat.co/badges/fedf65ac-45fa-4a3e-9151-13d459d71de0)](https://codebeat.co/projects/github-com-nanotaboada-java-samples-spring-boot-master) [![Maintainability](https://qlty.sh/badges/89f9e737-cc98-45c6-9b29-204388f5c1e4/maintainability.svg)](https://qlty.sh/gh/nanotaboada/projects/java.samples.spring.boot) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/ea6918db332642089ef420822267931b)](https://app.codacy.com/gh/nanotaboada/java.samples.spring.boot/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade) [![codecov](https://codecov.io/gh/nanotaboada/java.samples.spring.boot/branch/master/graph/badge.svg?token=D3FMNG0WOI)](https://codecov.io/gh/nanotaboada/java.samples.spring.boot) [![Known Vulnerabilities](https://snyk.io/test/github/nanotaboada/java.samples.spring.boot/badge.svg)](https://snyk.io/test/github/nanotaboada/java.samples.spring.boot)
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Line length

@sonarqubecloud
Copy link
Copy Markdown

@codacy-production
Copy link
Copy Markdown

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation Diff coverage
+0.00%
Coverage variation details
Coverable lines Covered lines Coverage
Common ancestor commit (e58fa24) 57 57 100.00%
Head commit (19e4a6f) 57 (+0) 57 (+0) 100.00% (+0.00%)

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details
Coverable lines Covered lines Diff coverage
Pull request (#163) 0 0 ∅ (not applicable)

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

See your quality gate settings    Change summary preferences

Codacy stopped sending the deprecated coverage status on June 5th, 2024. Learn more

Copy link
Copy Markdown

@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)
README.md (1)

5-5: Update: Status Badges Reflect New Metrics

The updated badges correctly replace the Code Climate maintainability badge with the Qlty.sh badge and add new badges for SonarCloud Bugs and Codebeat. All links and image sources appear correct.

Optional: Consider organizing the badges on multiple lines or grouping them for improved readability on smaller screens.

🧰 Tools
🪛 LanguageTool

[style] ~5-~5: Using many exclamation marks might seem excessive (in this case: 6 exclamation marks for a text that’s 2800 characters long)
Context: ...pring.boot/actions/workflows/maven.yml) Bugs CodeFactor codebeat badge Maintainability Codacy Badge [![codecov](https://codecov.io/gh/nanotabo...

(EN_EXCESSIVE_EXCLAMATION)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between e58fa24 and 19e4a6f.

📒 Files selected for processing (1)
  • README.md (1 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md

[style] ~5-~5: Using many exclamation marks might seem excessive (in this case: 6 exclamation marks for a text that’s 2800 characters long)
Context: ...pring.boot/actions/workflows/maven.yml) Bugs CodeFactor codebeat badge Maintainability Codacy Badge [![codecov](https://codecov.io/gh/nanotabo...

(EN_EXCESSIVE_EXCLAMATION)

⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Codacy Static Code Analysis

@nanotaboada nanotaboada merged commit cfbe710 into master Mar 24, 2025
19 checks passed
@nanotaboada nanotaboada deleted the feature/readme-status-badges branch March 24, 2025 23:18
@codecov
Copy link
Copy Markdown

codecov bot commented Mar 24, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 0.00%. Comparing base (e58fa24) to head (19e4a6f).
Report is 2 commits behind head on master.

Additional details and impacted files
@@             Coverage Diff             @@
##             master   #163       +/-   ##
===========================================
- Coverage     96.49%      0   -96.50%     
===========================================
  Files             2      0        -2     
  Lines            57      0       -57     
  Branches          6      0        -6     
===========================================
- Hits             55      0       -55     
+ Partials          2      0        -2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@coderabbitai coderabbitai bot mentioned this pull request Mar 30, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant