Skip to content

chore: add CI status and SDK version badges to README#11

Open
thepastaclaw wants to merge 1 commit intoPastaPastaPasta:mainfrom
thepastaclaw:chore/readme-badges
Open

chore: add CI status and SDK version badges to README#11
thepastaclaw wants to merge 1 commit intoPastaPastaPasta:mainfrom
thepastaclaw:chore/readme-badges

Conversation

@thepastaclaw
Copy link
Contributor

@thepastaclaw thepastaclaw commented Feb 19, 2026

Adds two badges to the README:

  • CI Status — shows deploy workflow status
  • Evo SDK Version — dynamically reads the @dashevo/evo-sdk version from package.json on main

Requested by thephez.

Validation

  • Verified badge markdown renders correctly on the GitHub PR file-change preview
  • Confirmed the CI status badge links to the correct workflow (deploy.yml) and displays the current build status
  • Confirmed the dynamic SDK version badge resolves via img.shields.io and displays the @dashevo/evo-sdk version from package.json on main
  • No code changes — README-only, so no build/test/lint steps required

Summary by CodeRabbit

  • Documentation
    • Added CI status badge to the README
    • Added dynamic SDK version badge to the README for improved project visibility

@coderabbitai
Copy link

coderabbitai bot commented Feb 19, 2026

📝 Walkthrough

Walkthrough

Added two documentation badges to README.md: a CI/deployment workflow badge and a dynamic Evo SDK version badge that reads from package.json. No functional changes to the codebase.

Changes

Cohort / File(s) Summary
Documentation Badges
README.md
Added CI workflow badge and dynamic Evo SDK version badge at the top of the README for improved project visibility.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 Badges bright upon the page,
Our README takes the stage,
CI checks and versions new,
Hopping forward, shiny too!
Documentation hops along,
Making every path less wrong.

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and accurately summarizes the main change: adding two badges (CI status and SDK version) to the README documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
  • 📝 Generate docstrings (stacked PR)
  • 📝 Generate docstrings (commit on current branch)
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Tip

Try Coding Plans. Let us write the prompt for your AI agent so you can ship faster (with fewer bugs).
Share your feedback on Discord.


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

Comment @coderabbitai help to get the list of available commands and usage tips.

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

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@README.md`:
- Line 4: The Evo SDK badge image Markdown (![Evo
SDK](https://img.shields.io/badge/dynamic/json?url=...)) has no link target;
wrap that image in a Markdown link pointing to the package page (for example
https://www.npmjs.com/package/@dashevo/evo-sdk) so the badge becomes clickable,
i.e. replace the standalone image token with a hyperlink that contains the same
image token.

# Dash Bridge

[![CI](https://github.com/PastaPastaPasta/dash-bridge/actions/workflows/deploy.yml/badge.svg)](https://github.com/PastaPastaPasta/dash-bridge/actions/workflows/deploy.yml)
![Evo SDK](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fraw.githubusercontent.com%2FPastaPastaPasta%2Fdash-bridge%2Fmain%2Fpackage.json&query=%24.dependencies%5B%22%40dashevo%2Fevo-sdk%22%5D&label=%40dashevo%2Fevo-sdk&color=blue)
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

🧩 Analysis chain

🏁 Script executed:

# Find and check package.json for `@dashevo/evo-sdk` location
fd -t f 'package.json' | head -5

Repository: PastaPastaPasta/dash-bridge

Length of output: 83


🏁 Script executed:

# Extract the section where `@dashevo/evo-sdk` is declared and its value
cat package.json | grep -A 50 '"dependencies"' | grep -B 5 -A 5 '@dashevo/evo-sdk' && echo "---" && cat package.json | grep -A 50 '"devDependencies"' | grep -B 5 -A 5 '@dashevo/evo-sdk'

Repository: PastaPastaPasta/dash-bridge

Length of output: 285


🏁 Script executed:

# Check the current badge syntax in README.md at line 4
sed -n '1,10p' README.md

Repository: PastaPastaPasta/dash-bridge

Length of output: 670


Make the Evo SDK badge clickable by wrapping it in a hyperlink.

The badge currently has no link target. For consistency with the CI badge above it and to allow readers to navigate to the package details, wrap it in a Markdown hyperlink pointing to the npm registry.

✏️ Proposed fix
-![Evo SDK](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fraw.githubusercontent.com%2FPastaPastaPasta%2Fdash-bridge%2Fmain%2Fpackage.json&query=%24.dependencies%5B%22%40dashevo%2Fevo-sdk%22%5D&label=%40dashevo%2Fevo-sdk&color=blue)
+[![Evo SDK](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fraw.githubusercontent.com%2FPastaPastaPasta%2Fdash-bridge%2Fmain%2Fpackage.json&query=%24.dependencies%5B%22%40dashevo%2Fevo-sdk%22%5D&label=%40dashevo%2Fevo-sdk&color=blue)](https://www.npmjs.com/package/@dashevo/evo-sdk)
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
![Evo SDK](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fraw.githubusercontent.com%2FPastaPastaPasta%2Fdash-bridge%2Fmain%2Fpackage.json&query=%24.dependencies%5B%22%40dashevo%2Fevo-sdk%22%5D&label=%40dashevo%2Fevo-sdk&color=blue)
[![Evo SDK](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fraw.githubusercontent.com%2FPastaPastaPasta%2Fdash-bridge%2Fmain%2Fpackage.json&query=%24.dependencies%5B%22%40dashevo%2Fevo-sdk%22%5D&label=%40dashevo%2Fevo-sdk&color=blue)](https://www.npmjs.com/package/@dashevo/evo-sdk)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@README.md` at line 4, The Evo SDK badge image Markdown (![Evo
SDK](https://img.shields.io/badge/dynamic/json?url=...)) has no link target;
wrap that image in a Markdown link pointing to the package page (for example
https://www.npmjs.com/package/@dashevo/evo-sdk) so the badge becomes clickable,
i.e. replace the standalone image token with a hyperlink that contains the same
image token.

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