chore: add CI status and SDK version badges to README#11
Conversation
📝 WalkthroughWalkthroughAdded 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
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches
🧪 Generate unit tests (beta)
Tip Try Coding Plans. Let us write the prompt for your AI agent so you can ship faster (with fewer bugs). 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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
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 () 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 | ||
|
|
||
| [](https://github.com/PastaPastaPasta/dash-bridge/actions/workflows/deploy.yml) | ||
|  |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
# Find and check package.json for `@dashevo/evo-sdk` location
fd -t f 'package.json' | head -5Repository: 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.mdRepository: 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
-
+[](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.
|  | |
| [](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 () 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.
thepastaclaw
force-pushed
the
chore/readme-badges
branch
from
edc5a3b to
c7774ca
Compare
|
✅ Review complete (commit c7774ca) |
thepastaclaw
left a comment
thepastaclaw
left a comment
There was a problem hiding this comment.
Code Review
Self-review note: GitHub does not allow requesting changes on my own PR, so this is posted as a comment review even though the findings below are blocking.
Both badges hardcode PastaPastaPasta/dash-bridge rather than the canonical dashpay/dash-bridge repository this PR targets, so the rendered README will surface workflow status and SDK version from a personal fork. The first badge additionally mislabels deploy.yml ("Deploy to GitHub Pages") as "CI" when a real ci.yml workflow (named "CI") exists in the repo.
🔴 2 blocking
🤖 Prompt for all review comments with AI agents
These findings are from an automated code review. Verify each finding against the current code and only fix it if needed.
In `README.md`:
- [BLOCKING] README.md:3: CI badge points to a personal fork and to the wrong workflow
The badge URL and link target `PastaPastaPasta/dash-bridge`, but this PR is opened against `dashpay/dash-bridge`. As written, the README on the canonical repo will display the fork's workflow status and link visitors to runs on the fork — misleading and fragile if the fork is renamed, deleted, or drifts.
It is also labeled "CI" while pointing at `deploy.yml`, whose actual workflow `name:` is "Deploy to GitHub Pages". The canonical repo has a `ci.yml` workflow named "CI" (added in #12). For a true CI status badge, the workflow file should be `ci.yml`; if the intent is to surface deploy status, the label should be "Deploy" instead.
- [BLOCKING] README.md:4: Dynamic SDK version badge reads package.json from a personal fork
The shields.io `url` parameter decodes to `https://raw.githubusercontent.com/PastaPastaPasta/dash-bridge/main/package.json`. The PR description says the badge reads `@dashevo/evo-sdk` from `main`'s `package.json`, but that source is the fork's main, not `dashpay/dash-bridge`'s. If the fork stops syncing, gets renamed, or is deleted, the canonical README will silently display a stale version or break. Point the source at the canonical repo.
| @@ -1,5 +1,8 @@ | |||
| # Dash Bridge | |||
|
|
|||
| [](https://github.com/PastaPastaPasta/dash-bridge/actions/workflows/deploy.yml) | |||
There was a problem hiding this comment.
🔴 Blocking: CI badge points to a personal fork and to the wrong workflow
The badge URL and link target PastaPastaPasta/dash-bridge, but this PR is opened against dashpay/dash-bridge. As written, the README on the canonical repo will display the fork's workflow status and link visitors to runs on the fork — misleading and fragile if the fork is renamed, deleted, or drifts.
It is also labeled "CI" while pointing at deploy.yml, whose actual workflow name: is "Deploy to GitHub Pages". The canonical repo has a ci.yml workflow named "CI" (added in #12). For a true CI status badge, the workflow file should be ci.yml; if the intent is to surface deploy status, the label should be "Deploy" instead.
| [](https://github.com/PastaPastaPasta/dash-bridge/actions/workflows/deploy.yml) | |
| [](https://github.com/dashpay/dash-bridge/actions/workflows/ci.yml) |
source: ['claude', 'codex']
| # Dash Bridge | ||
|
|
||
| [](https://github.com/PastaPastaPasta/dash-bridge/actions/workflows/deploy.yml) | ||
|  |
There was a problem hiding this comment.
🔴 Blocking: Dynamic SDK version badge reads package.json from a personal fork
The shields.io url parameter decodes to https://raw.githubusercontent.com/PastaPastaPasta/dash-bridge/main/package.json. The PR description says the badge reads @dashevo/evo-sdk from main's package.json, but that source is the fork's main, not dashpay/dash-bridge's. If the fork stops syncing, gets renamed, or is deleted, the canonical README will silently display a stale version or break. Point the source at the canonical repo.
|  | |
|  |
source: ['claude', 'codex']
1 participant
Adds two badges to the README:
@dashevo/evo-sdkversion frompackage.jsononmainRequested by thephez.
Validation
deploy.yml) and displays the current build statusimg.shields.ioand displays the@dashevo/evo-sdkversion frompackage.jsononmainSummary by CodeRabbit