chore: bump crates and docs #3
Conversation
QEDK
commented
Dec 15, 2025
QEDK
commented
- remove unsupported docker platform
- update docs
- bump crates
|
Review the following changes in direct dependencies. Learn more about Socket for GitHub.
|
There was a problem hiding this comment.
Pull request overview
This PR performs maintenance tasks including bumping dependency versions, updating documentation, and modifying Docker build configuration. The main changes involve updating the primitive-types crate from 0.12.2 to 0.14.0 (which includes a breaking API change), improving the README documentation with more detailed usage instructions, and adjusting the Docker release workflow to build only for ARM64 architecture.
- Updated dependencies including
primitive-types(0.12.2 → 0.14.0),clap(4.5.51 → 4.5.53), and various transitive dependencies - Enhanced README with comprehensive installation and usage instructions, including GitHub Actions and Docker examples
- Modified Docker release workflow to target only
linux/arm64platform
Reviewed changes
Copilot reviewed 4 out of 5 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| src/main.rs | Adapted encode_u256 function to match the new API of primitive-types 0.14.0 where to_big_endian() returns a value instead of mutating a parameter |
| README.md | Expanded documentation with detailed sections for installation from source, GitHub Actions integration, and Docker usage with pre-built and source-built images |
| Cargo.toml | Bumped version to 0.1.7 and updated dependencies: clap to 4.5.53 and primitive-types to 0.14.0 |
| Cargo.lock | Updated all dependency versions and their transitive dependencies to match Cargo.toml changes, including consolidation of windows-sys sub-crates |
| .github/workflows/release.yml | Removed linux/amd64 from Docker build platforms, now only building for linux/arm64 |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| with: | ||
| push: true | ||
| platforms: linux/amd64,linux/arm64 | ||
| platforms: linux/arm64 |
There was a problem hiding this comment.
Removing linux/amd64 from the platforms list means the Docker image will only be built for ARM64 architecture. This will prevent the vast majority of users on x86_64/AMD64 systems from using the pre-built Docker image. If this is intentional due to build issues, it should be documented in the README or PR description why AMD64 is unsupported. Otherwise, consider keeping both platforms or at least linux/amd64 as it's the most common architecture.
| platforms: linux/arm64 | |
| platforms: linux/amd64,linux/arm64 |
| let bytes = value.to_big_endian(); | ||
| out.copy_from_slice(&bytes); |
There was a problem hiding this comment.
The intermediate allocation and copy is unnecessary. If the new API for to_big_endian() returns [u8; 32] directly, you can simplify this to just return the result directly without creating out and copying into it.
| ### Install from source | ||
| To install soteria from source, ensure you have Rust and Cargo installed. Then, you can use the CLI tool as follows: | ||
| ```bash | ||
| cargo install --git https://github.com/monad-developers/soteria.git | ||
| soteria /path/to/your/logs/directory | ||
| ``` | ||
|
|
||
| ### Build and install from source | ||
| To build soteria from source, ensure you have Rust and Cargo installed. Then, clone the repository and build the project: | ||
| ```bash | ||
| git clone https://github.com/monad-developers/soteria.git | ||
| cd soteria | ||
| cargo install --path . | ||
| soteria /path/to/your/logs/directory |
There was a problem hiding this comment.
The sections "Install from source" and "Build and install from source" are redundant. Both sections describe installing from source using Cargo, with the only difference being whether you clone first. Consider consolidating these into a single "Install from source" section that shows both methods, or clarifying the distinction between installing directly from git vs building locally.
