foresterre/cargo-msrv

cargo-msrv Docker镜像文档

镜像概述

本镜像为https://github.com/foresterre/cargo-msrv%E5%B7%A5%E5%85%B7%E6%8F%90%E4%BE%9B%E5%AE%B9%E5%99%A8%E5%8C%96%E9%83%A8%E7%BD%B2%EF%BC%8Ccargo-msrv%E6%98%AF%E4%B8%80%E6%AC%BE%E7%94%A8%E4%BA%8E%E6%9F%A5%E6%89%BE%E3%80%81%E9%AA%8C%E8%AF%81Rust%E9%A1%B9%E7%9B%AE%E6%9C%80%E4%BD%8E%E6%94%AF%E6%8C%81Rust%E7%89%88%E6%9C%AC%EF%BC%88Minimum Supported Rust Version, MSRV）的命令行工具。通过Docker镜像，用户可在无需本地安装Rustup及cargo环境的情况下，快速使用cargo-msrv的全部功能，确保跨环境使用的一致性。

核心功能

• 查找MSRV：通过搜索确定当前Rust项目支持的最低Rust版本。
• 验证MSRV：检查项目是否符合声明的MSRV（通过Cargo.toml中的package.rust-version或package.metadata.msrv字段）。
• 列出依赖MSRV：显示项目依赖项声明的MSRV。
• 显示当前MSRV：查看项目当前声明的MSRV。
• 设置MSRV：为项目设置MSRV并更新Cargo.toml。

使用场景

• Rust项目开发初期，确定项目可支持的最低Rust版本，平衡兼容性与功能需求。
• 项目维护阶段，验证声明的MSRV是否仍然有效（如依赖更新后）。
• CI/CD流程集成，自动化检查MSRV兼容性，确保代码变更不破坏最低版本支持。
• 跨团队协作时，统一MSRV检测环境，避免本地配置差异导致的结果不一致。

部署与使用方法

镜像获取

从Docker Hub拉取（推荐）

bash
docker pull foresterre/cargo-msrv

本地构建镜像

bash
# 克隆仓库
git clone https://github.com/foresterre/cargo-msrv.git
cd cargo-msrv

# 构建镜像
docker build -t cargo-msrv .

基本运行命令

需将本地Rust项目目录挂载至容器内/app目录，基本命令格式：

bash
docker run -t -v "$(pwd)":/app foresterre/cargo-msrv [cargo-msrv命令及选项]

常用命令示例：

• 查找当前项目MSRV：

  bash
  docker run -t -v "$(pwd)":/app foresterre/cargo-msrv msrv find
  

• 验证项目声明的MSRV：

  bash
  docker run -t -v "$(pwd)":/app foresterre/cargo-msrv msrv verify
  

• 列出依赖项的MSRV：

  bash
  docker run -t -v "$(pwd)":/app foresterre/cargo-msrv msrv list
  

• 显示当前项目声明的MSRV：

  bash
  docker run -t -v "$(pwd)":/app foresterre/cargo-msrv msrv show
  

配置参数说明

路径与项目配置

输出格式控制

调试与日志选项

JSON输出格式

通过--output-format json启用JSON输出，事件以JSON行（json lines）形式打印，每行包含type字段指示事件类型（如版本检查开始、检查结果等）。示例命令：

bash
docker run -t -v "$(pwd)":/app foresterre/cargo-msrv msrv find --output-format json

详细JSON事件类型及结构可参考https://foresterre.github.io/cargo-msrv/output-formats/json.html%E3%80%82

注意事项

• 运行容器时需确保Rust项目目录正确挂载至容器内的/app目录（或通过--path指定其他容器内路径），否则工具无法访问项目文件。
• 镜像已预装Rustup，支持msrv find和msrv verify等依赖Rustup的命令，无需用户额外配置。
• 如需使用自定义兼容性检查命令（默认cargo check），可通过--传递，例如：docker run ... cargo-msrv msrv find -- cargo check --tests。