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

docs: update badges to use shields.io #88

Merged
merged 2 commits into from
Jul 4, 2024
Merged

docs: update badges to use shields.io #88

merged 2 commits into from
Jul 4, 2024

Conversation

Renato66
Copy link
Owner

@Renato66 Renato66 commented Jul 4, 2024

No description provided.

Copy link
Contributor

coderabbitai bot commented Jul 4, 2024

Walkthrough

The changes involve updating badge URLs in the README.md to use shields.io for GitHub Actions workflows and Codecov badges. A new usage badge was also added to reflect how many repositories use the auto-label action.

Changes

File Change Summary
README.md Updated badge URLs to shields.io for GitHub Actions workflows and Codecov; added a usage badge.

Poem

In the realm of code we dwell,
Badges now with stories tell,
Shields adorn our GitHub flow,
Reflecting usage, actions show.
Auto-label leads the way,
Guiding commits, bright as day. 🌟


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 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @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.
  • 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
Contributor

@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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between e58c00c and c4d1d8d.

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

[uncategorized] ~226-~226: A comma might be missing here.
Context: ...]' ```

## Badge To add a badge simple replace owner and repository ``...

(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)


[uncategorized] ~226-~226: A period might be missing here.
Context: ...To add a badge simple replace owner and repository ```markdown <!-- Replace , <REP...

(AI_EN_LECTOR_MISSING_PUNCTUATION_PERIOD)

Additional comments not posted (4)
README.md (4)

3-3: LGTM! Unit Test Badge URL updated correctly.

The Unit Test Badge URL has been successfully updated to use shields.io.


4-4: LGTM! Auto Label Badge URL updated correctly.

The Auto Label Badge URL has been successfully updated to use shields.io.


5-5: LGTM! Codecov Badge URL updated correctly.

The Codecov Badge URL has been successfully updated to use shields.io.


6-6: LGTM! Usage Badge added correctly.

The new Usage Badge has been successfully added.

README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between c4d1d8d and 5a45c59.

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

[uncategorized] ~226-~226: A comma might be missing here.
Context: ...]' ```

## Badge To add a badge simple replace , an...

(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)

Additional comments not posted (1)
README.md (1)

3-6: Approved: Improved badge consistency and appearance.

The updates to use shields.io for badges improve the visual consistency and appearance. Ensure the new URLs are correct and functional.

Verify the URLs:

Verification successful

Verified: Badge URLs are functional and correctly configured.

The badge URLs in the README.md file have been verified and are all returning a status code of 200, indicating they are functional and correctly configured.

  • GitHub Checks Workflow Status
  • Auto Label
  • Codecov
  • Usage
Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the new badge URLs are correct and functional.

# Test: Check the HTTP status code of the badge URLs. Expect: 200 OK.
urls=(
  "https://img.shields.io/github/actions/workflow/status/Renato66/auto-label/checks.yml?logo=github&label=Build"
  "https://img.shields.io/github/actions/workflow/status/Renato66/auto-label/auto-label.yml?logo=github&label=Auto%20Label"
  "https://img.shields.io/codecov/c/github/renato66/auto-label?logo=codecov"
  "https://img.shields.io/badge/used_by-125-blue?logo=githubactions&logoColor=FFF&logoSize=small"
)

for url in "${urls[@]}"; do
  status=$(curl -o /dev/null -s -w "%{http_code}\n" "$url")
  if [ "$status" -ne 200 ]; then
    echo "URL $url returned status code $status"
    exit 1
  fi
done
echo "All URLs are functional."

Length of output: 1295

README.md Show resolved Hide resolved
@Renato66 Renato66 merged commit 5fc2b85 into main Jul 4, 2024
1 check passed
@Renato66 Renato66 deleted the feat/count-action branch July 4, 2024 11:41
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