Skip to content
This repository was archived by the owner on Jan 23, 2026. It is now read-only.

Add some badges to README#764

Merged
mangelajo merged 6 commits intojumpstarter-dev:mainfrom
the78mole:patch-1
Dec 3, 2025
Merged

Add some badges to README#764
mangelajo merged 6 commits intojumpstarter-dev:mainfrom
the78mole:patch-1

Conversation

@the78mole
Copy link
Copy Markdown
Contributor

@the78mole the78mole commented Dec 2, 2025

Added badges for E2E tests, unit tests, documentation, various builds and DeepWiki.

Summary by CodeRabbit

  • Documentation
    • Updated README to add multiple status and release badges (E2E tests, unit tests, documentation, Wheels, flashing bundles, container image, GitHub Release, PyPI version, GitHub downloads, DeepWiki) to surface project health and release metadata.
    • No functional or behavioral changes — documentation-only update.

✏️ Tip: You can customize this high-level summary in your review settings.

Added badges for E2E tests, unit tests, documentation, various builds and DeepWiki.
@netlify
Copy link
Copy Markdown

netlify Bot commented Dec 2, 2025

Deploy Preview for jumpstarter-docs ready!

Name Link
🔨 Latest commit 85df57e
🔍 Latest deploy log https://app.netlify.com/projects/jumpstarter-docs/deploys/6930115de35d8a00082ba426
😎 Deploy Preview https://deploy-preview-764--jumpstarter-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Dec 2, 2025

Walkthrough

Added multiple new status and metadata badges to README.md (inserted after the Community Meeting section). No functional code, API, or exported/public entity changes; purely documentation/markdown edits.

Changes

Cohort / File(s) Change Summary
Documentation - Badges
README.md
Added multiple status and metadata badges (E2E Tests, Tests, Documentation, Wheels, Flashing bundles/OCI, Container image, GitHub Release, PyPI Version, GitHub Downloads, DeepWiki) to the README after the Community Meeting section.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

  • Review focus: verify badge image URLs, links, and rendering in README.

Possibly related PRs

Suggested reviewers

  • raballew
  • mangelajo

Poem

🐰 With ribbons, badges, gleam, and cheer,
I hop through README, bright and near.
Tests and docs and versions sing,
A little rabbit loves to bring
A tiny hop for every wing. 🥕

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'Add some badges to README' directly describes the main change in the PR, which is adding multiple badges to the README.md file.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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
Copy Markdown
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

🧹 Nitpick comments (1)
README.md (1)

14-17: Consider linking static information badges for consistency.

Lines 14-16 display static badges (Release, PyPI version, Downloads) without links. For better UX and consistency with the workflow badges above, consider linking them to their respective project pages (PyPI, GitHub releases, etc.). This is optional but improves discoverability.

Example refactor for PyPI version badge:

-![PyPI - Version](https://img.shields.io/pypi/v/jumpstarter)
+[![PyPI - Version](https://img.shields.io/pypi/v/jumpstarter)](https://pypi.org/project/jumpstarter/)
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 312a389 and 3a83359.

📒 Files selected for processing (1)
  • README.md (1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-11-27T09:58:41.875Z
Learnt from: CR
Repo: jumpstarter-dev/jumpstarter PR: 0
File: .cursor/rules/creating-new-drivers.mdc:0-0
Timestamp: 2025-11-27T09:58:41.875Z
Learning: Applies to packages/jumpstarter-driver-**/jumpstarter_driver_**/*.py : Driver implementations should follow existing code style validated with `make lint` (fix with `make lint-fix`), perform static type checking with `make ty-pkg-${package_name}`, add comprehensive tests, and verify all tests pass with `make test-pkg-${package_name}` or `make test`

Applied to files:

  • README.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (11)
  • GitHub Check: Redirect rules - jumpstarter-docs
  • GitHub Check: Header rules - jumpstarter-docs
  • GitHub Check: Pages changed - jumpstarter-docs
  • GitHub Check: build
  • GitHub Check: e2e
  • GitHub Check: pytest-matrix (ubuntu-24.04, 3.11)
  • GitHub Check: pytest-matrix (ubuntu-24.04, 3.12)
  • GitHub Check: pytest-matrix (macos-15, 3.12)
  • GitHub Check: pytest-matrix (ubuntu-24.04, 3.13)
  • GitHub Check: pytest-matrix (macos-15, 3.11)
  • GitHub Check: pytest-matrix (macos-15, 3.13)
🔇 Additional comments (1)
README.md (1)

7-12: Well-structured workflow status badges.

The GitHub Actions workflow badges are properly formatted and linked to their respective workflow runs. This provides clear visibility into CI/CD status.

Comment thread README.md Outdated
Copy link
Copy Markdown
Member

@mangelajo mangelajo left a comment

Choose a reason for hiding this comment

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

Looks great, shows how active the project is..

Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
the78mole and others added 5 commits December 3, 2025 11:24
Co-authored-by: Miguel Angel Ajo Pelayo <majopela@redhat.com>
Co-authored-by: Miguel Angel Ajo Pelayo <majopela@redhat.com>
Co-authored-by: Miguel Angel Ajo Pelayo <majopela@redhat.com>
Co-authored-by: Miguel Angel Ajo Pelayo <majopela@redhat.com>
Copy link
Copy Markdown
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: 2

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8f17db2 and 85df57e.

📒 Files selected for processing (1)
  • README.md (1 hunks)
🧰 Additional context used
🧠 Learnings (3)
📚 Learning: 2025-05-07T18:33:56.914Z
Learnt from: NickCao
Repo: jumpstarter-dev/jumpstarter PR: 425
File: packages/jumpstarter-driver-tasmota/README.md:23-23
Timestamp: 2025-05-07T18:33:56.914Z
Learning: In Jumpstarter documentation, configuration parameters should be presented in markdown tables rather than bulleted lists for better readability.

Applied to files:

  • README.md
📚 Learning: 2025-09-15T08:18:48.571Z
Learnt from: mangelajo
Repo: jumpstarter-dev/jumpstarter PR: 610
File: packages/jumpstarter-driver-flashers/jumpstarter_driver_flashers/client.py:488-491
Timestamp: 2025-09-15T08:18:48.571Z
Learning: In the jumpstarter project, code review suggestions should stay focused on the specific scope of the PR. Suggestions about general improvements like timeout handling or error handling that are unrelated to the core changes being made should be avoided, even if they apply to modified code lines.

Applied to files:

  • README.md
📚 Learning: 2025-09-24T16:13:14.244Z
Learnt from: mangelajo
Repo: jumpstarter-dev/jumpstarter PR: 644
File: packages/jumpstarter-driver-flashers/oci_bundles/aarch64-itb/build_fits.sh:16-18
Timestamp: 2025-09-24T16:13:14.244Z
Learning: The build script packages/jumpstarter-driver-flashers/oci_bundles/aarch64-itb/build_fits.sh is designed to run specifically on ARM containers to pick up the Fedora ARM kernel, so hardcoded aarch64 package references are intentional and correct.

Applied to files:

  • README.md
🪛 LanguageTool
README.md

[style] ~11-~11: Using many exclamation marks might seem excessive (in this case: 10 exclamation marks for a text that’s 2885 characters long)
Context: ...jumpstarter/actions/workflows/e2e.yaml) Tests documentation
Wheels [![Flashing bundles](https://github.com/ju...

(EN_EXCESSIVE_EXCLAMATION)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (8)
  • GitHub Check: build
  • GitHub Check: Redirect rules - jumpstarter-docs
  • GitHub Check: pytest-matrix (ubuntu-24.04, 3.12)
  • GitHub Check: pytest-matrix (ubuntu-24.04, 3.13)
  • GitHub Check: pytest-matrix (ubuntu-24.04, 3.11)
  • GitHub Check: Header rules - jumpstarter-docs
  • GitHub Check: e2e
  • GitHub Check: Pages changed - jumpstarter-docs

Comment thread README.md
Comment thread README.md
@mangelajo mangelajo enabled auto-merge (squash) December 3, 2025 11:00
@mangelajo mangelajo merged commit 615124b into jumpstarter-dev:main Dec 3, 2025
18 checks passed
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants