fwilkerson/golang-ci

docker-golang-build

镜像概述和主要用途

docker-golang-build是一个集成了多种开发工具的Golang镜像，旨在为Go项目提供一站式的开发环境。该镜像基于Golang官方镜像构建，额外预装了gcc（用于CGO支持）、golangci-lint（代码静态分析工具）、go-swagger（Swagger API文档生成工具）和go-acc（测试覆盖率分析工具），适用于Go项目的构建、代码质量检查、API文档生成及测试覆盖率收集等全流程开发需求。

核心功能和特性

• 基础Golang环境：包含完整的Golang开发环境，支持标准Go项目构建。
• CGO支持：预装gcc编译器，可处理包含C代码的Go项目（CGO）。
• 代码质量检查：集成golangci-lint，支持多维度代码静态分析（如代码风格、潜在bug、性能问题等）。
• API文档生成：内置go-swagger工具，可基于代码注释生成Swagger规范文档及交互式API页面。
• 测试覆盖率分析：包含go-acc工具，支持生成精确的测试覆盖率报告，便于代码质量评估。

使用场景和适用范围

• Go项目本地开发：作为本地开发环境，避免手动安装各类工具的繁琐步骤。
• CI/CD流程集成：在持续集成/持续部署流程中，用于自动化构建、代码检查、文档生成及测试覆盖率分析。
• API驱动开发：需生成Swagger API文档的Go项目，简化文档维护流程。
• 代码质量管控：需要严格代码规范和测试覆盖率要求的团队或项目。

使用方法和配置说明

基础使用

通过以下命令启动容器，将本地Go项目目录挂载到容器中：

bash
docker run -it --rm -v $(pwd):/app -w /app docker.xuanyuan.run/docker-golang-build

代码检查（golangci-lint）

在容器内执行代码静态检查：

bash
golangci-lint run ./...

生成API文档（go-swagger）

基于代码注释生成Swagger规范文件（swagger.json/swagger.yaml）：

bash
swagger generate spec -o ./swagger.json --scan-models

生成交互式API文档网页：

bash
swagger serve --no-open ./swagger.json

测试覆盖率分析（go-acc）

生成测试覆盖率报告：

bash
go-acc ./... --output coverage.txt

环境变量配置

可通过环境变量自定义工具行为，常用变量包括：

• GOPATH：Go工作目录（默认/go）
• GOLANGCI_LINT_FLAGS：golangci-lint默认参数（如--timeout 5m）
• GO_SWAGGER_VERSION：指定go-swagger版本（需镜像支持对应版本）

docker-compose示例

创建docker-compose.yml文件，集成开发环境：

yaml
version: '3'
services:
  go-build:
    image: docker.xuanyuan.run/docker-golang-build
    volumes:
      - ./:/app
    working_dir: /app
    command: sh -c "go mod download && golangci-lint run && go test ./..."

执行命令启动服务：

bash
docker-compose up