-
Notifications
You must be signed in to change notification settings - Fork 0
fix(ci): Fix docs.rs build + standardize badges #9
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
Conversation
Co-Authored-By: Claude Opus 4.5 <[email protected]>
…nd example repairs
- Remove unused web-sys dependency (WASM-only crate not needed) - Change CI docs job to use nightly Rust (required for docsrs features) - Use --features cli instead of --all-features for docs build - Bump version to 0.1.6 for crates.io republish Fixes: docs.rs build failures caused by: 1. --cfg docsrs triggering feature(doc_cfg) on stable Rust 2. --all-features including deps that require system libraries Co-Authored-By: Claude Opus 4.5 <[email protected]>
## reasonkit-mem (0.1.5) - Use nightly Rust for CI docs job (required for docsrs features) - Use --features compression to match docs.rs metadata - Add deny.toml for cargo-deny security checks - Standardize badges with consistent styling and brand colors - Add Downloads badge ## reasonkit-web (0.1.6) - Use --features full instead of --all-features for CI docs - Add deny.toml for cargo-deny security checks - Standardize badges with consistent styling and brand colors - Add Downloads badge ## reasonkit-core - Add Security badge - Add docs.rs badge (replaces custom docs badge) - Add Downloads badge - Standardize badge styling with brand colors ## reasonkit (meta-crate) - Center-align README header - Add Security badge placeholder (no workflow yet) - Add Downloads badge - Standardize badge styling with brand colors All repos now have consistent badge sets: - CI, Security, Crates.io, docs.rs, Downloads, License, Rust MSRV Co-Authored-By: Claude Opus 4.5 <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR aims to fix the docs.rs build configuration and standardize README badges. The changes use nightly Rust with the cli feature flag for documentation builds, update badge styling for consistency, and remove an unused web-sys dependency.
Changes:
- Updated CI workflow to use nightly Rust toolchain for docs with
--features cliflag - Standardized README badges with flat-square style and added Security, docs.rs, and Downloads badges
- Bumped version numbers and removed unused web-sys dependency
- Updated port numbers in documentation from 8080 to 9100
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
.github/workflows/ci.yml |
Changed docs job to use nightly Rust toolchain and build with --features cli instead of --all-features |
README.md |
Added new badges (Security, docs.rs, Downloads), updated links, and added extensive documentation cross-references |
Cargo.toml |
Bumped version to 0.1.6, removed unused web-sys dependency, added self-reference in dev-dependencies |
pyproject.toml |
Bumped version to 0.1.5, clarified python-source comment |
docs/reference/CLI_REFERENCE.md |
Updated default port from 8080 to 9100 in examples |
docs/guides/INTEGRATION.md |
Updated EXPOSE and containerPort from 8080 to 9100 |
docs/guides/DEPLOYMENT.md |
Updated various port references from 8080 to 9100 |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| [project] | ||
| name = "reasonkit" | ||
| version = "0.1.0" | ||
| version = "0.1.5" |
Copilot
AI
Jan 10, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Version inconsistency detected. The Cargo.toml is being updated to version 0.1.6, but pyproject.toml is being updated to version 0.1.5. These version numbers should match to maintain consistency across the project's Rust and Python packages.
| version = "0.1.5" | |
| version = "0.1.6" |
| | **Python Bindings** | 🔶 Beta | Build from source with `--features python` | | ||
|
|
||
| **Current Version:** v0.1.2 | [CHANGELOG](CHANGELOG.md) | [Releases](https://github.com/reasonkit/reasonkit-core/releases) | ||
| **Current Version:** v0.1.5 | [CHANGELOG](CHANGELOG.md) | [Releases](https://github.com/reasonkit/reasonkit-core/releases) • [📦 Crates.io](https://crates.io/crates/reasonkit-core) • [📚 Docs.rs](https://docs.rs/reasonkit-core) |
Copilot
AI
Jan 10, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The README.md indicates the current version is v0.1.5, which conflicts with Cargo.toml being updated to 0.1.6. Version numbers should be consistent across all project files.
| **Current Version:** v0.1.5 | [CHANGELOG](CHANGELOG.md) | [Releases](https://github.com/reasonkit/reasonkit-core/releases) • [📦 Crates.io](https://crates.io/crates/reasonkit-core) • [📚 Docs.rs](https://docs.rs/reasonkit-core) | |
| **Current Version:** v0.1.6 | [CHANGELOG](CHANGELOG.md) | [Releases](https://github.com/reasonkit/reasonkit-core/releases) • [📦 Crates.io](https://crates.io/crates/reasonkit-core) • [📚 Docs.rs](https://docs.rs/reasonkit-core) |
| # ============================================================================ | ||
|
|
||
| [dev-dependencies] | ||
| reasonkit = { package = "reasonkit-core", path = "." } |
Copilot
AI
Jan 10, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The dev-dependencies section is adding a self-reference by importing reasonkit-core as reasonkit from the current path. This circular dependency pattern is unusual and could cause issues with Cargo's dependency resolution. Consider whether this is necessary or if there's a better approach to achieve the intended functionality.
| reasonkit = { package = "reasonkit-core", path = "." } |
| rk serve --host 0.0.0.0 --port 9100 | ||
|
|
||
| # Behind nginx reverse proxy | ||
| rk serve --host 127.0.0.1 --port 8080 | ||
| rk serve --host 127.0.0.1 --port 9100 |
Copilot
AI
Jan 10, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The PR description states the changes are to "fix docs.rs build" and "standardize badges," but this pull request also includes port number changes from 8080 to 9100 in documentation files. These port changes are not mentioned in the PR description and appear to be unrelated to the stated goals. Consider either removing these changes from this PR or updating the PR description to reflect all the changes being made.
Implements high-performance, self-hosted badge generation system: Infrastructure: - Docker Compose with Shields.io and custom Rust metric feeder - Nginx reverse proxy configuration with differentiated caching - deploy.sh for easy deployment on Debian 13/Proxmox Rust Metric Feeder: - Live data from crates.io (version, downloads) - GitHub Actions CI status - docs.rs build status - System health metrics - Shields.io-compatible JSON endpoint format - ReasonKit brand colors (cyan, green, pink, purple, orange) Documentation: - BADGE_REFERENCE.md with complete badge code for all repos - README.md with architecture diagram and usage guide Also adds MCP badge to reasonkit-core README. Benefits: - Eliminates third-party DNS lookups (faster LCP) - Custom branding with brand colors - No visitor data leaked to external providers - Private metrics capability Co-Authored-By: Claude Opus 4.5 <[email protected]>
|
This PR has merge conflicts after the batch dependency update PR #8 was merged. Needs manual rebase to resolve conflicts before merging. |
Summary
--features cli(avoids web-sys dependency)Changes
.github/workflows/ci.yml: Use nightly Rust for docs job, correct featuresREADME.md: Rich, consistent badge system with brand colorsTest Plan
🤖 Generated with Claude Code