dotnet SDK 3.1 镜像文档

镜像概述和主要用途

概述

本镜像基于官方 Microsoft .NET SDK 3.1 镜像构建，额外集成了部署过程中常用的工具，旨在通过预安装依赖简化 .NET Core 3.1 项目的部署流程。

主要用途

提供包含基础开发环境及部署工具的一站式运行时环境，避免重复安装依赖，提升部署效率，适用于需要快速启动并包含特定工具链的场景。

核心功能和特性

基础功能

• 基于官方镜像：继承 Microsoft .NET SDK 3.1 镜像的全部功能，支持 .NET Core 3.1 应用的开发、编译、运行及发布。
• 完整开发环境：包含 .NET Core 3.1 SDK 工具链，支持 dotnet build、dotnet run、dotnet publish 等标准命令。

附加工具

集成以下部署常用工具，无需额外安装即可直接使用：

• Azure CLI：微软 Azure 云平台命令行工具，支持资源管理、部署等操作（参考 Azure CLI 文档）。
• dotnet reportgenerator：.NET 代码覆盖率报告生成工具，支持将覆盖率数据转换为多种格式（如 HTML、XML）。
• Zip：文件压缩工具，用于打包部署文件。
• Make：构建自动化工具，支持通过 Makefile 定义编译、测试、部署流程。

使用场景和适用范围

适用场景

• CI/CD 流水线：作为构建或部署阶段的运行环境，执行编译、测试、打包、发布等步骤。
• 自动化部署脚本：集成 Azure CLI，直接在容器内执行云资源部署命令。
• 代码覆盖率报告生成：通过 dotnet reportgenerator 快速生成测试覆盖率报告。
• 依赖 Makefile 的项目：需通过 Make 命令自动化构建或部署流程的 .NET Core 3.1 项目。

适用范围

• .NET Core 3.1 版本的应用开发、构建及部署。
• 需要上述附加工具链的开发或运维场景。

详细使用方法和配置说明

先决条件

• 已安装 Docker 环境（支持 Docker Engine 19.03+ 或兼容版本）。

获取镜像

镜像托管于 Docker Hub，可直接拉取使用：

docker pull njlnick/dotnet-sdk:3.1  # 假设镜像标签为 3.1，具体以 Docker Hub 实际标签为准

运行容器示例

1. 交互式运行（进入容器终端）

用于临时执行命令或调试：

docker run -it --rm njlnick/dotnet-sdk:3.1 bash

• -it：交互式终端模式
• --rm：容器退出后自动删除

2. 挂载本地项目目录（开发/构建场景）

将本地 .NET 项目目录挂载到容器内，执行构建或测试：

docker run -it --rm -v $(pwd):/app -w /app njlnick/dotnet-sdk:3.1 dotnet build

• -v $(pwd):/app：挂载当前目录到容器内 /app 路径
• -w /app：设置工作目录为 /app
• dotnet build：执行构建命令

3. 生成代码覆盖率报告（结合 reportgenerator）

假设项目已生成覆盖率文件（如 coverage.xml），通过以下命令生成 HTML 报告：

docker run -it --rm -v $(pwd):/app -w /app njlnick/dotnet-sdk:3.1 \
  dotnet reportgenerator -reports:coverage.xml -targetdir:./coverage-report -reporttypes:Html

4. 执行 Azure CLI 部署命令

在容器内直接调用 Azure CLI 进行资源部署：

docker run -it --rm njlnick/dotnet-sdk:3.1 az login  # 登录 Azure 账户（需手动输入凭据）

构建自定义镜像（可选）

如需基于本镜像进一步自定义（如添加更多工具），可通过以下步骤构建：

1. 克隆包含 Dockerfile 的仓库（假设已获取源码）。
2. 在 Dockerfile 所在目录执行构建命令：

   docker build -t custom-dotnet-sdk:3.1 .
   

   • -t custom-dotnet-sdk:3.1：指定自定义镜像名称及标签

配置参数与环境变量

本镜像未定义额外配置参数或环境变量，默认继承自基础镜像 Microsoft .NET SDK 3.1 的配置。如需自定义环境变量，可在 docker run 时通过 -e 参数指定，例如：

docker run -it --rm -e "ASPNETCORE_ENVIRONMENT=Production" njlnick/dotnet-sdk:3.1

镜像托管地址

• Docker Hub：njlnick/dotnet-sdk