Skip to content
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

Fix badge links #9

Merged
merged 1 commit into from
Feb 29, 2024
Merged

Fix badge links #9

merged 1 commit into from
Feb 29, 2024

Conversation

msmakouz
Copy link
Member

@msmakouz msmakouz commented Feb 29, 2024

Q A
Bugfix?
Breaks BC?
New feature?

Summary by CodeRabbit

  • Documentation
    • Updated URLs for Codecov, type-coverage, and psalm badges in the README to ensure accuracy and reliability of the documentation.

@msmakouz msmakouz added the documentation Improvements or additions to documentation label Feb 29, 2024
@msmakouz msmakouz self-assigned this Feb 29, 2024
Copy link

coderabbitai bot commented Feb 29, 2024

Walkthrough

The update in the roadrunner-tcp repository primarily involves modifications to the README.md file, where URLs for the Codecov, type-coverage, and psalm badges have been changed. This adjustment ensures that the links to these badges reflect the most current and accurate destinations, enhancing the documentation's reliability and user experience.

Changes

File Change Summary
README.md Updated URLs for Codecov, type-coverage, and psalm badges

🐰✨
In the realm of code, where rabbits dare to hop,
A README change, small yet keen, makes our hearts stop.
With URLs anew, badges shine bright,
Guiding through docs, in the moonlight.
Hop, hop, hurray, for changes so fine,
In the world of code, where everything's a sign.
🌟🐇

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

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>.
    • Generate unit-tests for this file.
  • 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 tests 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 generate interesting stats about this repository from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

Copy link

codecov bot commented Feb 29, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (aa2ace4) to head (71ac106).

Additional details and impacted files
@@             Coverage Diff             @@
##                 3.x        #9   +/-   ##
===========================================
  Coverage     100.00%   100.00%           
  Complexity        14        14           
===========================================
  Files              2         2           
  Lines             35        35           
===========================================
  Hits              35        35           

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

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.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between aa2ace4 and 71ac106.
Files selected for processing (1)
  • README.md (1 hunks)
Additional comments: 3
README.md (3)
  • 14-14: The URL for the Codecov badge has been updated. Please ensure that the new URL correctly points to the Codecov page for the roadrunner-php/tcp branch 3.x. This change is crucial for accurately reflecting the project's code coverage metrics.
  • 16-16: The URL for the type-coverage badge has been updated to point to shepherd.dev. It's important to verify that this URL accurately reflects the type coverage for the roadrunner-php/tcp repository. Additionally, ensure that the link to shepherd.dev/github/spiral/roadrunner-php/tcp in the URL is correct and not a typo, as it differs from the displayed link.
Verification successful

The corrected script successfully verified the URL for the type-coverage badge by fetching the HTTP headers and confirming a 200 OK response. This indicates that the URL https://shepherd.dev/github/roadrunner-php/tcp/coverage.svg is correct and accessible, thus verifying the URL for the type-coverage badge as intended in the review comment.

Scripts Executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Verify the correct URL for type-coverage badge
curl -I https://shepherd.dev/github/roadrunner-php/tcp/coverage.svg | grep HTTP/2 200

Length of output: 472



Script:

#!/bin/bash
# Corrected script to verify the correct URL for type-coverage badge
curl -s -I https://shepherd.dev/github/roadrunner-php/tcp/coverage.svg | grep "HTTP/2 200"

Length of output: 104

* 17-17: The URL for the psalm-level badge has been updated. Please confirm that the new URL correctly leads to the psalm level for the `roadrunner-php/tcp` repository on `shepherd.dev`. This change is essential for accurately displaying the project's code quality metrics.

@msmakouz msmakouz merged commit 2fc2fa7 into 3.x Feb 29, 2024
9 checks passed
@msmakouz msmakouz deleted the fix-badges branch February 29, 2024 10:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
2 participants